You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2015/04/09 14:54:41 UTC
svn commit: r1672325 - in /tomcat/trunk/java/org/apache/coyote: ./ ajp/
http11/ http11/filters/
Author: markt
Date: Thu Apr 9 12:54:41 2015
New Revision: 1672325
URL: http://svn.apache.org/r1672325
Log:
Javadoc fixes for InputBuffer
Modified:
tomcat/trunk/java/org/apache/coyote/InputBuffer.java
tomcat/trunk/java/org/apache/coyote/ajp/AjpProcessor.java
tomcat/trunk/java/org/apache/coyote/http11/Http11InputBuffer.java
tomcat/trunk/java/org/apache/coyote/http11/InputFilter.java
tomcat/trunk/java/org/apache/coyote/http11/filters/ChunkedInputFilter.java
tomcat/trunk/java/org/apache/coyote/http11/filters/IdentityInputFilter.java
tomcat/trunk/java/org/apache/coyote/http11/filters/SavedRequestInputFilter.java
tomcat/trunk/java/org/apache/coyote/http11/filters/VoidInputFilter.java
Modified: tomcat/trunk/java/org/apache/coyote/InputBuffer.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/coyote/InputBuffer.java?rev=1672325&r1=1672324&r2=1672325&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/InputBuffer.java (original)
+++ tomcat/trunk/java/org/apache/coyote/InputBuffer.java Thu Apr 9 12:54:41 2015
@@ -27,11 +27,17 @@ import org.apache.tomcat.util.buf.ByteCh
public interface InputBuffer {
/**
- * Read from the input
- * Return from the input stream.
- IMPORTANT: the current model assumes that the protocol will 'own' the
- buffer and return a pointer to it in ByteChunk ( i.e. the param will
- have chunk.getBytes()==null before call, and the result after the call ).
- */
+ * Read from the input stream into the given buffer.
+ * IMPORTANT: the current model assumes that the protocol will 'own' the
+ * buffer and return a pointer to it in ByteChunk (i.e. the param will
+ * have chunk.getBytes()==null before call, and the result after the call).
+ *
+ * @param chunk The buffer to read data into.
+ *
+ * @return The number of bytes that have been added to the buffer or -1 for
+ * end of stream
+ *
+ * @throws IOException If an I/O error occurs reading from the input stream
+ */
public int doRead(ByteChunk chunk) throws IOException;
}
Modified: tomcat/trunk/java/org/apache/coyote/ajp/AjpProcessor.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/coyote/ajp/AjpProcessor.java?rev=1672325&r1=1672324&r2=1672325&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/ajp/AjpProcessor.java (original)
+++ tomcat/trunk/java/org/apache/coyote/ajp/AjpProcessor.java Thu Apr 9 12:54:41 2015
@@ -1584,9 +1584,6 @@ public class AjpProcessor extends Abstra
*/
protected class SocketInputBuffer implements InputBuffer {
- /**
- * Read bytes into the specified chunk.
- */
@Override
public int doRead(ByteChunk chunk) throws IOException {
Modified: tomcat/trunk/java/org/apache/coyote/http11/Http11InputBuffer.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/coyote/http11/Http11InputBuffer.java?rev=1672325&r1=1672324&r2=1672325&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/http11/Http11InputBuffer.java (original)
+++ tomcat/trunk/java/org/apache/coyote/http11/Http11InputBuffer.java Thu Apr 9 12:54:41 2015
@@ -292,9 +292,6 @@ public class Http11InputBuffer implement
// ---------------------------------------------------- InputBuffer Methods
- /**
- * Read some bytes.
- */
@Override
public int doRead(ByteChunk chunk) throws IOException {
@@ -1046,9 +1043,6 @@ public class Http11InputBuffer implement
*/
private class SocketInputBuffer implements InputBuffer {
- /**
- * Read bytes into the specified chunk.
- */
@Override
public int doRead(ByteChunk chunk) throws IOException {
Modified: tomcat/trunk/java/org/apache/coyote/http11/InputFilter.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/coyote/http11/InputFilter.java?rev=1672325&r1=1672324&r2=1672325&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/http11/InputFilter.java (original)
+++ tomcat/trunk/java/org/apache/coyote/http11/InputFilter.java Thu Apr 9 12:54:41 2015
@@ -30,16 +30,6 @@ import org.apache.tomcat.util.buf.ByteCh
*/
public interface InputFilter extends InputBuffer {
-
- /**
- * Read bytes.
- *
- * @return Number of bytes read.
- */
- @Override
- public int doRead(ByteChunk chunk) throws IOException;
-
-
/**
* Some filters need additional parameters from the request. All the
* necessary reading can occur in that method, as this method is called
Modified: tomcat/trunk/java/org/apache/coyote/http11/filters/ChunkedInputFilter.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/coyote/http11/filters/ChunkedInputFilter.java?rev=1672325&r1=1672324&r2=1672325&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/http11/filters/ChunkedInputFilter.java (original)
+++ tomcat/trunk/java/org/apache/coyote/http11/filters/ChunkedInputFilter.java Thu Apr 9 12:54:41 2015
@@ -164,15 +164,6 @@ public class ChunkedInputFilter implemen
// ---------------------------------------------------- InputBuffer Methods
- /**
- * Read bytes.
- *
- * @return If the filter does request length control, this value is
- * significant; it should be the number of bytes consumed from the buffer,
- * up until the end of the current request body, or the buffer length,
- * whichever is greater. If the filter does not do request body length
- * control, the returned value should be -1.
- */
@Override
public int doRead(ByteChunk chunk) throws IOException {
if (endChunk) {
Modified: tomcat/trunk/java/org/apache/coyote/http11/filters/IdentityInputFilter.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/coyote/http11/filters/IdentityInputFilter.java?rev=1672325&r1=1672324&r2=1672325&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/http11/filters/IdentityInputFilter.java (original)
+++ tomcat/trunk/java/org/apache/coyote/http11/filters/IdentityInputFilter.java Thu Apr 9 12:54:41 2015
@@ -90,15 +90,6 @@ public class IdentityInputFilter impleme
// ---------------------------------------------------- InputBuffer Methods
- /**
- * Read bytes.
- *
- * @return If the filter does request length control, this value is
- * significant; it should be the number of bytes consumed from the buffer,
- * up until the end of the current request body, or the buffer length,
- * whichever is greater. If the filter does not do request body length
- * control, the returned value should be -1.
- */
@Override
public int doRead(ByteChunk chunk) throws IOException {
Modified: tomcat/trunk/java/org/apache/coyote/http11/filters/SavedRequestInputFilter.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/coyote/http11/filters/SavedRequestInputFilter.java?rev=1672325&r1=1672324&r2=1672325&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/http11/filters/SavedRequestInputFilter.java (original)
+++ tomcat/trunk/java/org/apache/coyote/http11/filters/SavedRequestInputFilter.java Thu Apr 9 12:54:41 2015
@@ -43,9 +43,6 @@ public class SavedRequestInputFilter imp
this.input = input;
}
- /**
- * Read bytes.
- */
@Override
public int doRead(ByteChunk chunk) throws IOException {
if(input.getOffset()>= input.getEnd())
Modified: tomcat/trunk/java/org/apache/coyote/http11/filters/VoidInputFilter.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/coyote/http11/filters/VoidInputFilter.java?rev=1672325&r1=1672324&r2=1672325&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/http11/filters/VoidInputFilter.java (original)
+++ tomcat/trunk/java/org/apache/coyote/http11/filters/VoidInputFilter.java Thu Apr 9 12:54:41 2015
@@ -49,11 +49,6 @@ public class VoidInputFilter implements
// ---------------------------------------------------- InputBuffer Methods
- /**
- * Write some bytes.
- *
- * @return number of bytes written by the filter
- */
@Override
public int doRead(ByteChunk chunk) throws IOException {
return -1;
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org