Author: markt Date: Tue Oct 14 19:54:42 2014 New Revision: 1631858 URL: http://svn.apache.org/r1631858 Log: Java 8 Javadoc issues for o.a.t.websocket package
Modified: tomcat/trunk/java/org/apache/tomcat/websocket/Transformation.java tomcat/trunk/java/org/apache/tomcat/websocket/WsSession.java tomcat/trunk/java/org/apache/tomcat/websocket/server/UpgradeUtil.java tomcat/trunk/java/org/apache/tomcat/websocket/server/WsFrameServer.java tomcat/trunk/java/org/apache/tomcat/websocket/server/WsServerContainer.java Modified: tomcat/trunk/java/org/apache/tomcat/websocket/Transformation.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/Transformation.java?rev=1631858&r1=1631857&r2=1631858&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/websocket/Transformation.java (original) +++ tomcat/trunk/java/org/apache/tomcat/websocket/Transformation.java Tue Oct 14 19:54:42 2014 @@ -30,6 +30,7 @@ public interface Transformation { /** * Sets the next transformation in the pipeline. + * @param t The next transformation */ void setNext(Transformation t); @@ -52,6 +53,9 @@ public interface Transformation { /** * Obtain the extension that describes the information to be returned to the * client. + * + * @return The extension information that describes the parameters that have + * been agreed for this transformation */ Extension getExtensionResponse(); @@ -63,6 +67,11 @@ public interface Transformation { * @param rsv The reserved bits for the frame currently being * processed * @param dest The buffer in which the data is to be written + * + * @return The result of trying to read more data from the transform + * + * @throws IOException If an I/O error occurs while reading data from the + * transform */ TransformationResult getMoreData(byte opCode, boolean fin, int rsv, ByteBuffer dest) throws IOException; Modified: tomcat/trunk/java/org/apache/tomcat/websocket/WsSession.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/WsSession.java?rev=1631858&r1=1631857&r2=1631858&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/websocket/WsSession.java (original) +++ tomcat/trunk/java/org/apache/tomcat/websocket/WsSession.java Tue Oct 14 19:54:42 2014 @@ -106,10 +106,34 @@ public class WsSession implements Sessio * at the time this constructor is called will be used when calling * {@link Endpoint#onClose(Session, CloseReason)}. * - * @param localEndpoint - * @param wsRemoteEndpoint - * @param negotiatedExtensions - * @throws DeploymentException + * @param localEndpoint The end point managed by this code + * @param wsRemoteEndpoint The other / remote endpoint + * @param wsWebSocketContainer The container that created this session + * @param requestUri The URI used to connect to this endpoint or + * <code>null</code> is this is a client session + * @param requestParameterMap The parameters associated with the request + * that initiated this session or + * <code>null</code> if this is a client session + * @param queryString The query string associated with the request + * that initiated this session or + * <code>null</code> if this is a client session + * @param userPrincipal The principal associated with the request + * that initiated this session or + * <code>null</code> if this is a client session + * @param httpSessionId The HTTP session ID associated with the + * request that initiated this session or + * <code>null</code> if this is a client session + * @param negotiatedExtensions The agreed extensions to use for this session + * @param subProtocol The agreed subprotocol to use for this + * session + * @param pathParameters The path parameters associated with the + * request that initiated this session or + * <code>null</code> if this is a client session + * @param secure Was this session initiated over a secure + * connection? + * @param endpointConfig The configuration information for the + * endpoint + * @throws DeploymentException if an invalid encode is specified */ public WsSession(Endpoint localEndpoint, WsRemoteEndpointImplBase wsRemoteEndpoint, @@ -455,6 +479,9 @@ public class WsSession implements Sessio * Called when a close message is received. Should only ever happen once. * Also called after a protocol error when the ProtocolHandler needs to * force the closing of the connection. + * + * @param closeReason The reason contained within the received close + * message. */ public void onClose(CloseReason closeReason) { Modified: tomcat/trunk/java/org/apache/tomcat/websocket/server/UpgradeUtil.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/server/UpgradeUtil.java?rev=1631858&r1=1631857&r2=1631858&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/websocket/server/UpgradeUtil.java (original) +++ tomcat/trunk/java/org/apache/tomcat/websocket/server/UpgradeUtil.java Tue Oct 14 19:54:42 2014 @@ -65,6 +65,11 @@ public class UpgradeUtil { * Note: RFC 2616 does not limit HTTP upgrade to GET requests but the Java * WebSocket spec 1.0, section 8.2 implies such a limitation and RFC * 6455 section 4.1 requires that a WebSocket Upgrade uses GET. + * @param request The request to check if it is an HTTP upgrade request for + * a WebSocket connection + * @param response The response associated with the request + * @return <code>true</code> if the request includes a HTTP Upgrade request + * for the WebSocket protocol, otherwise <code>false</code> */ public static boolean isWebSocketUpgradeRequest(ServletRequest request, ServletResponse response) { Modified: tomcat/trunk/java/org/apache/tomcat/websocket/server/WsFrameServer.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/server/WsFrameServer.java?rev=1631858&r1=1631857&r2=1631858&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/websocket/server/WsFrameServer.java (original) +++ tomcat/trunk/java/org/apache/tomcat/websocket/server/WsFrameServer.java Tue Oct 14 19:54:42 2014 @@ -40,6 +40,9 @@ public class WsFrameServer extends WsFra /** * Called when there is data in the ServletInputStream to process. + * + * @throws IOException if an I/O error occurs while processing the available + * data */ public void onDataAvailable() throws IOException { synchronized (connectionReadLock) { Modified: tomcat/trunk/java/org/apache/tomcat/websocket/server/WsServerContainer.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/server/WsServerContainer.java?rev=1631858&r1=1631857&r2=1631858&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/tomcat/websocket/server/WsServerContainer.java (original) +++ tomcat/trunk/java/org/apache/tomcat/websocket/server/WsServerContainer.java Tue Oct 14 19:54:42 2014 @@ -166,7 +166,8 @@ public class WsServerContainer extends W * must be called before calling this method. * * @param sec The configuration to use when creating endpoint instances - * @throws DeploymentException + * @throws DeploymentException if the endpoint can not be published as + * requested */ @Override public void addEndpoint(ServerEndpointConfig sec) --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org