tomcat-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ma...@apache.org
Subject svn commit: r1416262 - in /tomcat/trunk/java/org/apache/tomcat/websocket: Constants.java PathParam.java PojoMethodMapping.java UriTemplate.java WsEndpointPojo.java WsProtocolHandler.java WsServlet.java
Date Sun, 02 Dec 2012 21:15:32 GMT
Author: markt
Date: Sun Dec  2 21:15:30 2012
New Revision: 1416262

URL: http://svn.apache.org/viewvc?rev=1416262&view=rev
Log:
Add some Javadoc

Modified:
    tomcat/trunk/java/org/apache/tomcat/websocket/Constants.java
    tomcat/trunk/java/org/apache/tomcat/websocket/PathParam.java
    tomcat/trunk/java/org/apache/tomcat/websocket/PojoMethodMapping.java
    tomcat/trunk/java/org/apache/tomcat/websocket/UriTemplate.java
    tomcat/trunk/java/org/apache/tomcat/websocket/WsEndpointPojo.java
    tomcat/trunk/java/org/apache/tomcat/websocket/WsProtocolHandler.java
    tomcat/trunk/java/org/apache/tomcat/websocket/WsServlet.java

Modified: tomcat/trunk/java/org/apache/tomcat/websocket/Constants.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/Constants.java?rev=1416262&r1=1416261&r2=1416262&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/websocket/Constants.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/websocket/Constants.java Sun Dec  2 21:15:30 2012
@@ -16,6 +16,9 @@
  */
 package org.apache.tomcat.websocket;
 
+/**
+ * Internal implementation constants.
+ */
 public class Constants {
 
     protected static final String PACKAGE_NAME = "org.apache.tomcat.websocket";

Modified: tomcat/trunk/java/org/apache/tomcat/websocket/PathParam.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/PathParam.java?rev=1416262&r1=1416261&r2=1416262&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/websocket/PathParam.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/websocket/PathParam.java Sun Dec  2 21:15:30 2012
@@ -16,6 +16,13 @@
  */
 package org.apache.tomcat.websocket;
 
+/**
+ * Stores the parameter type and name for a parameter that needs to be passed to
+ * an onXxx method of {@link javax.websocket.Endpoint}. The name is only present
+ * for parameters annotated with {@link javax.websocket.WebSocketPathParam}. For
+ * the {@link javax.websocket.Session} and {@link java.lang.Throwable}
+ * parameters, {@link #getName()} will always return <code>null</code>.
+ */
 public class PathParam {
     private final Class<?> type;
     private final String name;

Modified: tomcat/trunk/java/org/apache/tomcat/websocket/PojoMethodMapping.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/PojoMethodMapping.java?rev=1416262&r1=1416261&r2=1416262&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/websocket/PojoMethodMapping.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/websocket/PojoMethodMapping.java Sun Dec  2 21:15:30
2012
@@ -26,6 +26,11 @@ import javax.websocket.WebSocketError;
 import javax.websocket.WebSocketOpen;
 import javax.websocket.WebSocketPathParam;
 
+/**
+ * For a POJO class annotated with {@link javax.websocket.WebSocketEndpoint}, an
+ * instance of this class caches the method and parameter information for the
+ * onXXX calls.
+ */
 public class PojoMethodMapping {
 
     private final Method onOpen;

Modified: tomcat/trunk/java/org/apache/tomcat/websocket/UriTemplate.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/UriTemplate.java?rev=1416262&r1=1416261&r2=1416262&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/websocket/UriTemplate.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/websocket/UriTemplate.java Sun Dec  2 21:15:30 2012
@@ -23,6 +23,10 @@ import java.util.Map;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+/**
+ * Extracts path parameters from URIs used to create web socket connections
+ * using the URI template defined for the associated Endpoint.
+ */
 public class UriTemplate {
 
     private final Pattern pattern;

Modified: tomcat/trunk/java/org/apache/tomcat/websocket/WsEndpointPojo.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/WsEndpointPojo.java?rev=1416262&r1=1416261&r2=1416262&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/websocket/WsEndpointPojo.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/websocket/WsEndpointPojo.java Sun Dec  2 21:15:30
2012
@@ -24,6 +24,11 @@ import javax.websocket.Endpoint;
 import javax.websocket.EndpointConfiguration;
 import javax.websocket.Session;
 
+/**
+ * Wrapper class for instances of POJOs annotated with
+ * {@link javax.websocket.WebSocketEndpoint} so they appear as standard
+ * {@link Endpoint} instances.
+ */
 public class WsEndpointPojo extends Endpoint {
 
     private final Object pojo;

Modified: tomcat/trunk/java/org/apache/tomcat/websocket/WsProtocolHandler.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/WsProtocolHandler.java?rev=1416262&r1=1416261&r2=1416262&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/websocket/WsProtocolHandler.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/websocket/WsProtocolHandler.java Sun Dec  2 21:15:30
2012
@@ -20,6 +20,9 @@ import javax.servlet.http.ProtocolHandle
 import javax.servlet.http.WebConnection;
 import javax.websocket.Endpoint;
 
+/**
+ * Servlet 3.1 HTTP upgrade handler for WebSocket connections.
+ */
 public class WsProtocolHandler implements ProtocolHandler {
 
     private final Endpoint ep;

Modified: tomcat/trunk/java/org/apache/tomcat/websocket/WsServlet.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/websocket/WsServlet.java?rev=1416262&r1=1416261&r2=1416262&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/websocket/WsServlet.java (original)
+++ tomcat/trunk/java/org/apache/tomcat/websocket/WsServlet.java Sun Dec  2 21:15:30 2012
@@ -37,7 +37,9 @@ import javax.websocket.Endpoint;
 import javax.websocket.ServerEndpointConfiguration;
 import javax.xml.bind.DatatypeConverter;
 
-
+/**
+ * Handles the initial HTTP connection for WebSocket connections.
+ */
 public class WsServlet extends HttpServlet {
 
     private static final long serialVersionUID = 1L;



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Mime
View raw message