Author: markt
Date: Mon Apr 29 19:46:59 2013
New Revision: 1477298
URL: http://svn.apache.org/r1477298
Log:
Better Javadoc
Modified:
tomcat/trunk/java/javax/servlet/ServletInputStream.java
Modified: tomcat/trunk/java/javax/servlet/ServletInputStream.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletInputStream.java?rev=1477298&r1=1477297&r2=1477298&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletInputStream.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletInputStream.java Mon Apr 29 19:46:59
2013
@@ -97,7 +97,17 @@ public abstract class ServletInputStream
public abstract boolean isReady();
/**
- * Sets the {@link ReadListener} for this {@link ServletInputStream}.
+ * Sets the {@link ReadListener} for this {@link ServletInputStream} and
+ * thereby switching to non-blocking IO. It is only valid to switch to
+ * non-blocking IO within async processing or HTTP upgrade processing.
+ *
+ * @param listener The non-blocking IO read listener
+ *
+ * @throws IllegalStateException If this method is called if neither
+ * async nor HTTP upgrade is in progress
or
+ * if the {@link ReadListener} has already
+ * been set
+ * @throws NullPointerException If listener is null
*/
public abstract void setReadListener(ReadListener listener);
}
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
