Author: markt
Date: Sat Nov 7 21:17:43 2015
New Revision: 1713182
URL: http://svn.apache.org/viewvc?rev=1713182&view=rev
Log:
Javadoc
This complete the org.apache.coyote package which is now warning free
Modified:
tomcat/trunk/java/org/apache/coyote/http11/InputFilter.java
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=1713182&r1=1713181&r2=1713182&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/http11/InputFilter.java (original)
+++ tomcat/trunk/java/org/apache/coyote/http11/InputFilter.java Sat Nov 7
21:17:43 2015
@@ -31,9 +31,9 @@ import org.apache.tomcat.util.buf.ByteCh
public interface InputFilter extends InputBuffer {
/**
- * Some filters need additional parameters from the request. All the
- * necessary reading can occur in that method, as this method is called
- * after the request header processing is complete.
+ * Some filters need additional parameters from the request.
+ *
+ * @param request The request to be associated with this filter
*/
public void setRequest(Request request);
@@ -46,12 +46,18 @@ public interface InputFilter extends Inp
/**
* Get the name of the encoding handled by this filter.
+ *
+ * @return The encoding name as a byte chunk to facilitate comparison with
+ * the value read from the HTTP headers which will also be a
+ * ByteChunk
*/
public ByteChunk getEncodingName();
/**
* Set the next buffer in the filter pipeline.
+ *
+ * @param buffer The next buffer
*/
public void setBuffer(InputBuffer buffer);
@@ -63,19 +69,25 @@ public interface InputFilter extends Inp
* too many bytes were read. This method is allowed to use buffer.doRead
* to consume extra bytes. The result of this method can't be negative (if
* an error happens, an IOException should be thrown instead).
+ *
+ * @throws IOException If an error happens
*/
- public long end()
- throws IOException;
+ public long end() throws IOException;
/**
* Amount of bytes still available in a buffer.
+ *
+ * @return The number of bytes in the buffer
*/
public int available();
/**
* Has the request body been read fully?
+ *
+ * @return {@code true} if the request body has been fully read, otherwise
+ * {@code false}
*/
public boolean isFinished();
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
