Author: remm
Date: Thu Jan 14 15:57:49 2016
New Revision: 1724638
URL: http://svn.apache.org/viewvc?rev=1724638&view=rev
Log:
Javadoc fixes.
Modified:
tomcat/trunk/java/org/apache/coyote/AbstractProcessor.java
tomcat/trunk/java/org/apache/coyote/AbstractProcessorLight.java
tomcat/trunk/java/org/apache/coyote/AbstractProtocol.java
tomcat/trunk/java/org/apache/coyote/ajp/AjpProcessor.java
tomcat/trunk/java/org/apache/coyote/http11/Http11OutputBuffer.java
tomcat/trunk/java/org/apache/coyote/http11/filters/ChunkedInputFilter.java
tomcat/trunk/java/org/apache/coyote/http2/AbstractStream.java
Modified: tomcat/trunk/java/org/apache/coyote/AbstractProcessor.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/coyote/AbstractProcessor.java?rev=1724638&r1=1724637&r2=1724638&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/AbstractProcessor.java (original)
+++ tomcat/trunk/java/org/apache/coyote/AbstractProcessor.java Thu Jan 14
15:57:49 2016
@@ -55,9 +55,8 @@ public abstract class AbstractProcessor
/**
* Used by HTTP/2.
- *
- * @param coyoteRequest
- * @param coyoteResponse
+ * @param coyoteRequest The request
+ * @param coyoteResponse The response
*/
protected AbstractProcessor(Request coyoteRequest, Response
coyoteResponse) {
this(null, coyoteRequest, coyoteResponse);
@@ -83,6 +82,8 @@ public abstract class AbstractProcessor
/**
* Update the current error state to the new error state if the new error
* state is more severe than the current error state.
+ * @param errorState The error status details
+ * @param t The error which occurred
*/
protected void setErrorState(ErrorState errorState, Throwable t) {
boolean blockIo = this.errorState.isIoAllowed() &&
!errorState.isIoAllowed();
@@ -135,6 +136,7 @@ public abstract class AbstractProcessor
/**
* Set the socket wrapper being used.
+ * @param socketWrapper The socket wrapper
*/
protected final void setSocketWrapper(SocketWrapperBase<?> socketWrapper) {
this.socketWrapper = socketWrapper;
@@ -142,7 +144,7 @@ public abstract class AbstractProcessor
/**
- * Get the socket wrapper being used.
+ * @return the socket wrapper being used.
*/
protected final SocketWrapperBase<?> getSocketWrapper() {
return socketWrapper;
@@ -156,7 +158,7 @@ public abstract class AbstractProcessor
/**
- * Obtain the Executor used by the underlying endpoint.
+ * @return the Executor used by the underlying endpoint.
*/
protected Executor getExecutor() {
return endpoint.getExecutor();
Modified: tomcat/trunk/java/org/apache/coyote/AbstractProcessorLight.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/coyote/AbstractProcessorLight.java?rev=1724638&r1=1724637&r2=1724638&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/AbstractProcessorLight.java (original)
+++ tomcat/trunk/java/org/apache/coyote/AbstractProcessorLight.java Thu Jan 14
15:57:49 2016
@@ -144,6 +144,8 @@ public abstract class AbstractProcessorL
* Uses currently include Servlet 3.0 Async and HTTP upgrade connections.
* Further uses may be added in the future. These will typically start as
* HTTP requests.
+ * @param status The event to process
+ * @return the socket state
*/
protected abstract SocketState dispatch(SocketEvent status);
Modified: tomcat/trunk/java/org/apache/coyote/AbstractProtocol.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/coyote/AbstractProtocol.java?rev=1724638&r1=1724637&r2=1724638&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/AbstractProtocol.java (original)
+++ tomcat/trunk/java/org/apache/coyote/AbstractProtocol.java Thu Jan 14
15:57:49 2016
@@ -393,6 +393,7 @@ public abstract class AbstractProtocol<S
/**
* Concrete implementations need to provide access to their logger to be
* used by the abstract classes.
+ * @return the logger
*/
protected abstract Log getLog();
@@ -400,19 +401,22 @@ public abstract class AbstractProtocol<S
/**
* Obtain the prefix to be used when construction a name for this protocol
* handler. The name will be prefix-address-port.
+ * @return the prefix
*/
protected abstract String getNamePrefix();
/**
* Obtain the name of the protocol, (Http, Ajp, etc.). Used with JMX.
+ * @return the protocol name
*/
protected abstract String getProtocolName();
/**
+ * Find a suitable handler for the protocol negotiated
+ * at the network layer.
* @param name The name of the requested negotiated protocol.
- *
* @return The instance where {@link UpgradeProtocol#getAlpnName()} matches
* the requested protocol
*/
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=1724638&r1=1724637&r2=1724638&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/ajp/AjpProcessor.java (original)
+++ tomcat/trunk/java/org/apache/coyote/ajp/AjpProcessor.java Thu Jan 14
15:57:49 2016
@@ -932,8 +932,10 @@ public class AjpProcessor extends Abstra
/**
* Get more request body data from the web server and store it in the
* internal buffer.
- *
- * @return true if there is more data, false if not.
+ * @param block <code>true</code> if this is blocking IO
+ * @return <code>true</code> if there is more data,
+ * <code>false</code> if not.
+ * @throws IOException An IO error occurred
*/
protected boolean refillReadBuffer(boolean block) throws IOException {
// When using replay (e.g. after FORM auth) all the data to read has
Modified: tomcat/trunk/java/org/apache/coyote/http11/Http11OutputBuffer.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/coyote/http11/Http11OutputBuffer.java?rev=1724638&r1=1724637&r2=1724638&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/http11/Http11OutputBuffer.java
(original)
+++ tomcat/trunk/java/org/apache/coyote/http11/Http11OutputBuffer.java Thu Jan
14 15:57:49 2016
@@ -527,7 +527,7 @@ public class Http11OutputBuffer implemen
* @param block Should this method block until the buffer is empty
* @return <code>true</code> if data remains in the buffer (which can only
* happen in non-blocking mode) else <code>false</code>.
- * @throws IOException
+ * @throws IOException Error writing data
*/
protected boolean flushBuffer(boolean block) throws IOException {
return socketWrapper.flush(block);
@@ -536,6 +536,7 @@ public class Http11OutputBuffer implemen
/**
* Is standard Servlet blocking IO being used for output?
+ * @return <code>true</code> if this is blocking IO
*/
protected final boolean isBlocking() {
return response.getWriteListener() == null;
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=1724638&r1=1724637&r2=1724638&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/http11/filters/ChunkedInputFilter.java
(original)
+++ tomcat/trunk/java/org/apache/coyote/http11/filters/ChunkedInputFilter.java
Thu Jan 14 15:57:49 2016
@@ -305,6 +305,8 @@ public class ChunkedInputFilter implemen
/**
* Read bytes from the previous buffer.
+ * @return The byte count which has been read
+ * @throws IOException Read error
*/
protected int readBytes() throws IOException {
@@ -327,6 +329,9 @@ public class ChunkedInputFilter implemen
* The letters before CRLF or ';' (whatever comes first) must be valid hex
* digits. We should not parse F23IAMGONNAMESSTHISUP34CRLF as a valid
* header according to the spec.
+ * @return <code>true</code> if the chunk header has been
+ * successfully parsed
+ * @throws IOException Read error
*/
protected boolean parseChunkHeader() throws IOException {
@@ -397,6 +402,7 @@ public class ChunkedInputFilter implemen
* @param tolerant Should tolerant parsing (LF and CRLF) be used? This
* is recommended (RFC2616, section 19.3) for message
* headers.
+ * @throws IOException An error occurred parsing CRLF
*/
protected void parseCRLF(boolean tolerant) throws IOException {
@@ -431,6 +437,7 @@ public class ChunkedInputFilter implemen
/**
* Parse end chunk data.
+ * @throws IOException Error propagation
*/
protected void parseEndChunk() throws IOException {
// Handle optional trailer headers
Modified: tomcat/trunk/java/org/apache/coyote/http2/AbstractStream.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/coyote/http2/AbstractStream.java?rev=1724638&r1=1724637&r2=1724638&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/http2/AbstractStream.java (original)
+++ tomcat/trunk/java/org/apache/coyote/http2/AbstractStream.java Thu Jan 14
15:57:49 2016
@@ -105,8 +105,10 @@ abstract class AbstractStream {
/**
- * @param increment
- * @throws Http2Exception
+ * Increment window size.
+ * @param increment The amount of the incrementation
+ * @throws Http2Exception If the window size is now higher than
+ * the maximum allowed
*/
protected synchronized void incrementWindowSize(int increment) throws
Http2Exception {
// No need for overflow protection here.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
