Cosmetic changes
authormarkt <markt@13f79535-47bb-0310-9956-ffa450edef68>
Sat, 6 Jun 2009 12:49:12 +0000 (12:49 +0000)
committermarkt <markt@13f79535-47bb-0310-9956-ffa450edef68>
Sat, 6 Jun 2009 12:49:12 +0000 (12:49 +0000)
 - make since tags consistent
 - Add TODOs were required
 - Fix copy and paste errors in javadoc

git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@782244 13f79535-47bb-0310-9956-ffa450edef68

21 files changed:
java/javax/servlet/AsyncContext.java
java/javax/servlet/AsyncEvent.java
java/javax/servlet/AsyncListener.java
java/javax/servlet/DispatcherType.java
java/javax/servlet/FilterRegistration.java
java/javax/servlet/Registration.java
java/javax/servlet/ServletContainerInitializer.java
java/javax/servlet/ServletContext.java
java/javax/servlet/ServletRegistration.java
java/javax/servlet/ServletRequest.java
java/javax/servlet/ServletRequestWrapper.java
java/javax/servlet/ServletResponseWrapper.java
java/javax/servlet/SessionTrackingMode.java
java/javax/servlet/annotation/HandlesTypes.java
java/javax/servlet/annotation/WebFilter.java
java/javax/servlet/annotation/WebInitParam.java
java/javax/servlet/annotation/WebServlet.java
java/javax/servlet/http/Cookie.java
java/javax/servlet/http/HttpServletResponse.java
java/javax/servlet/http/HttpServletResponseWrapper.java
java/javax/servlet/http/Part.java

index 691a6e3..a553596 100644 (file)
@@ -17,9 +17,9 @@
 package javax.servlet;
 
 /**
- * @since 3.0
+ * @since Servlet 3.0
  * $Id$
- * TODO SERVLET3
+ * TODO SERVLET3 - Add comments
  */
 public interface AsyncContext {
     public static final String ASYNC_REQUEST_URI =
index e165291..3012de9 100644 (file)
@@ -17,7 +17,7 @@
 package javax.servlet;
 
 /**
- * @since 3.0
+ * @since Servlet 3.0
  * $Id$
  * TODO SERVLET3 - Add comments
  */
index a5d74c4..c83b225 100644 (file)
@@ -20,7 +20,7 @@ import java.io.IOException;
 import java.util.EventListener;
 
 /**
- * @since 3.0
+ * @since Servlet 3.0
  * $Id$
  * TODO SERVLET3 - Add comments
  */
index 0224fcb..d68acb2 100644 (file)
@@ -17,7 +17,7 @@
 package javax.servlet;
 
 /**
- * @since 3.0
+ * @since Servlet 3.0
  * $Id$
  */
 public enum DispatcherType {
index bd1b54e..59967a0 100644 (file)
@@ -19,7 +19,7 @@ package javax.servlet;
 import java.util.EnumSet;
 
 /**
- * @since 3.0
+ * @since Servlet 3.0
  * $Id$
  * TODO SERVLET3 - Add comments
  */
@@ -33,7 +33,8 @@ public interface FilterRegistration extends Registration {
      * @throws IllegalArgumentException
      * @throws IllegalStateException
      */
-    public void addMappingForServletNames(EnumSet<DispatcherType> dispatcherTypes,
+    public void addMappingForServletNames(
+            EnumSet<DispatcherType> dispatcherTypes,
             boolean isMatchAfter, String... servletNames);
     
     /**
@@ -44,7 +45,8 @@ public interface FilterRegistration extends Registration {
      * @throws IllegalArgumentException
      * @throws IllegalStateException
      */
-    public void addMappingForUrlPatterns(EnumSet<DispatcherType> dispatcherTypes,
+    public void addMappingForUrlPatterns(
+            EnumSet<DispatcherType> dispatcherTypes,
             boolean isMatchAfter, String... urlPatterns);
 
     public static interface Dynamic
index a55c08e..f45594d 100644 (file)
@@ -20,7 +20,7 @@ import java.util.Map;
 import java.util.Set;
 
 /**
- * @since 3.0
+ * @since Servlet 3.0
  * $Id$
  * TODO SERVLET3 - Add comments
  */
index a0651e6..6c8d458 100644 (file)
@@ -17,7 +17,7 @@
 package javax.servlet;
 
 /**
- * @since 3.0
+ * @since Servlet 3.0
  * $Id$
  * TODO SERVLET3 - Add comments
  */
index 205e9ff..6a6d6e4 100644 (file)
@@ -533,6 +533,7 @@ public interface ServletContext {
      * @return
      * @throws IllegalStateException
      * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public boolean setInitParameter(String name, String value);
     
@@ -660,7 +661,8 @@ public interface ServletContext {
      * @param className
      * @throws IllegalStateException    If the context has already been
      *                                  initialised
-     * @since 3.0
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public ServletRegistration.Dynamic addServlet(String servletName,
             String className);
@@ -670,9 +672,10 @@ public interface ServletContext {
      * 
      * @param servletName
      * @param servlet
-     * @since 3.0
      * @throws IllegalStateException    If the context has already been
      *                                  initialised
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public ServletRegistration.Dynamic addServlet(String servletName,
             Servlet servlet);
@@ -682,9 +685,10 @@ public interface ServletContext {
      * 
      * @param servletName
      * @param servletClass
-     * @since 3.0
      * @throws IllegalStateException    If the context has already been
      *                                  initialised
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public ServletRegistration.Dynamic addServlet(String servletName,
             Class<? extends Servlet> servletClass);
@@ -696,6 +700,7 @@ public interface ServletContext {
      * @return
      * @throws ServletException
      * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public <T extends Servlet> T createServlet(Class<T> c)
     throws ServletException;
@@ -706,6 +711,7 @@ public interface ServletContext {
      * @param servletName
      * @return
      * @since Servlet 3.0 
+     * TODO SERVLET3 - Add comments
      */
     public ServletRegistration findServletRegistration(String servletName);
 
@@ -717,7 +723,8 @@ public interface ServletContext {
      * @throws IllegalStateException    If the context has already been
      *                                  initialised
      * 
-     * @since 3.0
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public FilterRegistration.Dynamic  addFilter(String filterName,
             String className);
@@ -730,7 +737,8 @@ public interface ServletContext {
      * @throws IllegalStateException    If the context has already been
      *                                  initialised
      * 
-     * @since 3.0
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public FilterRegistration.Dynamic  addFilter(String filterName,
             Filter filter);
@@ -743,7 +751,8 @@ public interface ServletContext {
      * @throws IllegalStateException    If the context has already been
      *                                  initialised
      * 
-     * @since 3.0
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public FilterRegistration.Dynamic  addFilter(String filterName,
             Class<? extends Filter> filterClass);
@@ -755,6 +764,7 @@ public interface ServletContext {
      * @return
      * @throws ServletException
      * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public <T extends Filter> T createFilter(Class<T> c)
     throws ServletException;
@@ -765,6 +775,7 @@ public interface ServletContext {
      * @param filterName
      * @return
      * @since Servlet 3.0 
+     * TODO SERVLET3 - Add comments
      */
     public FilterRegistration findFilterRegistration(String filterName);
 
@@ -772,7 +783,8 @@ public interface ServletContext {
     /**
      * 
      * @return
-     * @since 3.0
+     * @since Servlet 3.0 
+     * TODO SERVLET3 - Add comments
      */
     public SessionCookieConfig getSessionCookieConfig();
 
@@ -785,7 +797,8 @@ public interface ServletContext {
      *                                  {@link SessionTrackingMode}
      * @throws IllegalStateException    If the context has already been
      *                                  initialised
-     * @since 3.0
+     * @since Servlet 3.0 
+     * TODO SERVLET3 - Add comments
      */
     public void setSessionTrackingModes(
             EnumSet<SessionTrackingMode> sessionTrackingModes)
@@ -794,14 +807,16 @@ public interface ServletContext {
     /**
      * 
      * @return
-     * @since 3.0
+     * @since Servlet 3.0 
+     * TODO SERVLET3 - Add comments
      */
     public EnumSet<SessionTrackingMode> getDefaultSessionTrackingModes();
     
     /**
      * 
      * @return
-     * @since 3.0
+     * @since Servlet 3.0 
+     * TODO SERVLET3 - Add comments
      */
     public EnumSet<SessionTrackingMode> getEffectiveSessionTrackingModes();
     
index da21578..3de9935 100644 (file)
@@ -19,7 +19,7 @@ package javax.servlet;
 import java.util.Set;
 
 /**
- * @since 3.0
+ * @since Servlet 3.0
  * $Id$
  * TODO SERVLET3 - Add comments
  */
index 7045e68..8d6873b 100644 (file)
@@ -597,7 +597,8 @@ public interface ServletRequest {
     /**
      * 
      * @return
-     * @since 3.0
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public ServletContext getServletContext();
     
@@ -606,7 +607,8 @@ public interface ServletRequest {
      * @return
      * @throws java.lang.IllegalStateException  If async is not supported for
      *                                          this request
-     * @since 3.0
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public AsyncContext startAsync();
     
@@ -616,7 +618,8 @@ public interface ServletRequest {
      * @param servletResponse
      * @return
      * @throws java.lang.IllegalStateException
-     * @since 3.0
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public AsyncContext startAsync(ServletRequest servletRequest,
             ServletResponse servletResponse);
@@ -624,14 +627,16 @@ public interface ServletRequest {
     /**
      * 
      * @return
-     * @since 3.0
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public boolean isAsyncStarted();
     
     /**
      * 
      * @return
-     * @since 3.0
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public boolean isAsyncSupported();
     
@@ -639,14 +644,16 @@ public interface ServletRequest {
      * 
      * @return
      * @throws java.lang.IllegalStateException
-     * @since 3.0
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public AsyncContext getAsyncContext();
 
     /**
      * 
      * @param listener
-     * @since 3.0
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public void addAsyncListener(AsyncListener listener);
 
@@ -655,7 +662,8 @@ public interface ServletRequest {
      * @param listener
      * @param servletRequest
      * @param servletResponse
-     * @since 3.0
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public void addAsyncListener(AsyncListener listener,
             ServletRequest servletRequest, ServletResponse servletResponse);
@@ -664,7 +672,8 @@ public interface ServletRequest {
      * 
      * @param timeout
      * @throws java.lang.IllegalStateException
-     * @since 3.0
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public void setAsyncTimeout(long timeout);
     
@@ -672,7 +681,8 @@ public interface ServletRequest {
     /**
      * 
      * @return
-     * @since 3.0
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public long getAsyncTimeout();
 
@@ -680,7 +690,8 @@ public interface ServletRequest {
     /**
      * 
      * @return
-     * @since 3.0
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public DispatcherType getDispatcherType();
 }
index f86ead2..755a965 100644 (file)
@@ -403,7 +403,7 @@ public class ServletRequestWrapper implements ServletRequest {
      * getServletContext() on the wrapped request object.
      * 
      * @return
-     * @since 3.0
+     * @since Servlet 3.0
      */
     public ServletContext getServletContext() {
         return request.getServletContext();
@@ -415,7 +415,7 @@ public class ServletRequestWrapper implements ServletRequest {
      * 
      * @return
      * @throws java.lang.IllegalStateException
-     * @since 3.0
+     * @since Servlet 3.0
      */
     public AsyncContext startAsync() {
         return request.startAsync();
@@ -429,7 +429,7 @@ public class ServletRequestWrapper implements ServletRequest {
      * @param servletResponse
      * @return
      * @throws java.lang.IllegalStateException
-     * @since 3.0
+     * @since Servlet 3.0
      */
     public AsyncContext startAsync(ServletRequest servletRequest,
             ServletResponse servletResponse)
@@ -442,7 +442,7 @@ public class ServletRequestWrapper implements ServletRequest {
      * isAsyncStarted() on the wrapped request object.
      * 
      * @return
-     * @since 3.0
+     * @since Servlet 3.0
      */
     public boolean isAsyncStarted() {
         return request.isAsyncStarted();
@@ -453,7 +453,7 @@ public class ServletRequestWrapper implements ServletRequest {
      * isAsyncSupported() on the wrapped request object.
      * 
      * @return
-     * @since 3.0
+     * @since Servlet 3.0
      */
     public boolean isAsyncSupported() {
         return request.isAsyncSupported();
@@ -464,7 +464,7 @@ public class ServletRequestWrapper implements ServletRequest {
      * getAsyncContext() on the wrapped request object.
      * 
      * @return
-     * @since 3.0
+     * @since Servlet 3.0
      */
     public AsyncContext getAsyncContext() {
         return request.getAsyncContext();
@@ -475,7 +475,7 @@ public class ServletRequestWrapper implements ServletRequest {
      * addAsyncListener(AsyncListener) on the wrapped request object.
      * 
      * @param listener
-     * @since 3.0
+     * @since Servlet 3.0
      */
     public void addAsyncListener(AsyncListener listener) {
         request.addAsyncListener(listener);
@@ -489,7 +489,7 @@ public class ServletRequestWrapper implements ServletRequest {
      * @param listener
      * @param servletRequest
      * @param servletResponse
-     * @since 3.0
+     * @since Servlet 3.0
      */
     public void addAsyncListener(AsyncListener listener,
             ServletRequest servletRequest, ServletResponse servletResponse) {
@@ -501,7 +501,7 @@ public class ServletRequestWrapper implements ServletRequest {
      * setAsyncTimeout(long) on the wrapped request object.
      * 
      * @param listener
-     * @since 3.0
+     * @since Servlet 3.0
      */
     public void setAsyncTimeout(long timeout) {
         request.setAsyncTimeout(timeout);
@@ -511,7 +511,7 @@ public class ServletRequestWrapper implements ServletRequest {
      * The default behavior of this method is to call
      * getAsyncTimeout() on the wrapped request object.
      * 
-     * @since 3.0
+     * @since Servlet 3.0
      */
     public long getAsyncTimeout() {
         return request.getAsyncTimeout();
@@ -519,8 +519,9 @@ public class ServletRequestWrapper implements ServletRequest {
     
     /**
      * 
-     * @param listener
-     * @since 3.0
+     * @param wrapped
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public boolean isWrapperFor(ServletRequest wrapped) {
         if (request == wrapped) {
@@ -534,8 +535,9 @@ public class ServletRequestWrapper implements ServletRequest {
     
     /**
      * 
-     * @param listener
-     * @since 3.0
+     * @param wrappedType
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public boolean isWrapperFor(Class<? extends ServletRequest> wrappedType) {
         if (wrappedType.isAssignableFrom(request.getClass())) {
@@ -551,7 +553,7 @@ public class ServletRequestWrapper implements ServletRequest {
      * The default behavior of this method is to call
      * getDispatcherType() on the wrapped request object.
      * 
-     * @since 3.0
+     * @since Servlet 3.0
      */
     public DispatcherType getDispatcherType() {
         return this.request.getDispatcherType();
index 371f123..f144210 100644 (file)
@@ -211,8 +211,9 @@ public class ServletResponseWrapper implements ServletResponse {
 
     /**
      * 
-     * @param listener
-     * @since 3.0
+     * @param wrapped
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public boolean isWrapperFor(ServletResponse wrapped) {
         if (response == wrapped) {
@@ -226,8 +227,9 @@ public class ServletResponseWrapper implements ServletResponse {
     
     /**
      * 
-     * @param listener
-     * @since 3.0
+     * @param wrappedType
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public boolean isWrapperFor(Class<? extends ServletResponse> wrappedType) {
         if (wrappedType.isAssignableFrom(response.getClass())) {
index fcb49af..8821ba8 100644 (file)
@@ -17,7 +17,7 @@
 package javax.servlet;
 
 /**
- * @since 3.0
+ * @since Servlet 3.0
  * $Id$
  */
 public enum SessionTrackingMode {
index 3a48f3d..82ec9f6 100644 (file)
@@ -23,9 +23,9 @@ import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**
- * @since 3.0
+ * @since Servlet 3.0
  * $Id$
- * TODO SERVLET3
+ * TODO SERVLET3 - Add comments
  */
 @Target({ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
index 42f8eb5..a3946a4 100644 (file)
@@ -25,9 +25,9 @@ import java.lang.annotation.Documented;
 import javax.servlet.DispatcherType;
 
 /**
- * @since 3.0
+ * @since Servlet 3.0
  * $Id$
- * TODO SERVLET3
+ * TODO SERVLET3 - Add comments
  */
 @Target({ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
index f0c8cf1..b77ac46 100644 (file)
@@ -23,9 +23,9 @@ import java.lang.annotation.Target;
 import java.lang.annotation.Documented;
 
 /**
- * @since 3.0
+ * @since Servlet 3.0
  * $Id$
- * TODO SERVLET3
+ * TODO SERVLET3 - Add comments
  */
 @Target({ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
index d8593ea..3f3b386 100644 (file)
@@ -23,9 +23,9 @@ import java.lang.annotation.Target;
 import java.lang.annotation.Documented;
 
 /**
- * @since 3.0
+ * @since Servlet 3.0
  * $Id$
- * TODO SERVLET3
+ * TODO SERVLET3 - Add comments
  */
 @Target({ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
index bd85198..f174ead 100644 (file)
@@ -537,7 +537,8 @@ public class Cookie implements Cloneable {
     /**
      * 
      * @return
-     * @since 3.0
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public boolean isHttpOnly() {
         return httpOnly;
@@ -546,7 +547,8 @@ public class Cookie implements Cloneable {
     /**
      * 
      * @param httpOnly
-     * since 3.0
+     * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public void setHttpOnly(boolean httpOnly) {
         this.httpOnly = httpOnly;
index 1df15c7..0a9bf62 100644 (file)
@@ -326,6 +326,7 @@ public interface HttpServletResponse extends ServletResponse {
      * 
      * @return
      * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public int getStatus();
     
@@ -335,6 +336,7 @@ public interface HttpServletResponse extends ServletResponse {
      * @param name
      * @return
      * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public String getHeader(String name);
     
@@ -344,6 +346,7 @@ public interface HttpServletResponse extends ServletResponse {
      * @param name
      * @return
      * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public Iterable<String> getHeaders(String name);
 
@@ -352,6 +355,7 @@ public interface HttpServletResponse extends ServletResponse {
      * 
      * @return
      * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public Iterable<String> getHeaderNames();
 
index fe35971..f003e4b 100644 (file)
@@ -198,6 +198,7 @@ public class HttpServletResponseWrapper extends ServletResponseWrapper implement
 
     /**
      * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public int getStatus() {
         return this._getHttpServletResponse().getStatus();
@@ -206,6 +207,7 @@ public class HttpServletResponseWrapper extends ServletResponseWrapper implement
      
     /**
      * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public String getHeader(String name) {
         return this._getHttpServletResponse().getHeader(name);
@@ -214,6 +216,7 @@ public class HttpServletResponseWrapper extends ServletResponseWrapper implement
     
     /**
      * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public Iterable<String> getHeaders(String name) {
         return this._getHttpServletResponse().getHeaders(name);
@@ -221,6 +224,7 @@ public class HttpServletResponseWrapper extends ServletResponseWrapper implement
 
     /**
      * @since Servlet 3.0
+     * TODO SERVLET3 - Add comments
      */
     public Iterable<String> getHeaderNames() {
         return this._getHttpServletResponse().getHeaderNames();
index 5db7744..7f9ca50 100644 (file)
@@ -21,6 +21,7 @@ import java.io.InputStream;
 
 /**
  * @since Servlet 3.0
+ * TODO SERVLET3 - Add comments
  */
 public interface Part {
     public InputStream getInputStream() throws IOException;