From: markt Date: Sat, 6 Jun 2009 12:49:12 +0000 (+0000) Subject: Cosmetic changes X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=0af600b51dced20b64498255f149ba5018a78e9a;p=tomcat7.0 Cosmetic changes - 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 --- diff --git a/java/javax/servlet/AsyncContext.java b/java/javax/servlet/AsyncContext.java index 691a6e35c..a553596b7 100644 --- a/java/javax/servlet/AsyncContext.java +++ b/java/javax/servlet/AsyncContext.java @@ -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 = diff --git a/java/javax/servlet/AsyncEvent.java b/java/javax/servlet/AsyncEvent.java index e16529196..3012de9af 100644 --- a/java/javax/servlet/AsyncEvent.java +++ b/java/javax/servlet/AsyncEvent.java @@ -17,7 +17,7 @@ package javax.servlet; /** - * @since 3.0 + * @since Servlet 3.0 * $Id$ * TODO SERVLET3 - Add comments */ diff --git a/java/javax/servlet/AsyncListener.java b/java/javax/servlet/AsyncListener.java index a5d74c444..c83b225a3 100644 --- a/java/javax/servlet/AsyncListener.java +++ b/java/javax/servlet/AsyncListener.java @@ -20,7 +20,7 @@ import java.io.IOException; import java.util.EventListener; /** - * @since 3.0 + * @since Servlet 3.0 * $Id$ * TODO SERVLET3 - Add comments */ diff --git a/java/javax/servlet/DispatcherType.java b/java/javax/servlet/DispatcherType.java index 0224fcb40..d68acb2e7 100644 --- a/java/javax/servlet/DispatcherType.java +++ b/java/javax/servlet/DispatcherType.java @@ -17,7 +17,7 @@ package javax.servlet; /** - * @since 3.0 + * @since Servlet 3.0 * $Id$ */ public enum DispatcherType { diff --git a/java/javax/servlet/FilterRegistration.java b/java/javax/servlet/FilterRegistration.java index bd1b54e41..59967a0d9 100644 --- a/java/javax/servlet/FilterRegistration.java +++ b/java/javax/servlet/FilterRegistration.java @@ -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 dispatcherTypes, + public void addMappingForServletNames( + EnumSet dispatcherTypes, boolean isMatchAfter, String... servletNames); /** @@ -44,7 +45,8 @@ public interface FilterRegistration extends Registration { * @throws IllegalArgumentException * @throws IllegalStateException */ - public void addMappingForUrlPatterns(EnumSet dispatcherTypes, + public void addMappingForUrlPatterns( + EnumSet dispatcherTypes, boolean isMatchAfter, String... urlPatterns); public static interface Dynamic diff --git a/java/javax/servlet/Registration.java b/java/javax/servlet/Registration.java index a55c08edf..f45594d5a 100644 --- a/java/javax/servlet/Registration.java +++ b/java/javax/servlet/Registration.java @@ -20,7 +20,7 @@ import java.util.Map; import java.util.Set; /** - * @since 3.0 + * @since Servlet 3.0 * $Id$ * TODO SERVLET3 - Add comments */ diff --git a/java/javax/servlet/ServletContainerInitializer.java b/java/javax/servlet/ServletContainerInitializer.java index a0651e6f0..6c8d45803 100644 --- a/java/javax/servlet/ServletContainerInitializer.java +++ b/java/javax/servlet/ServletContainerInitializer.java @@ -17,7 +17,7 @@ package javax.servlet; /** - * @since 3.0 + * @since Servlet 3.0 * $Id$ * TODO SERVLET3 - Add comments */ diff --git a/java/javax/servlet/ServletContext.java b/java/javax/servlet/ServletContext.java index 205e9ff05..6a6d6e473 100644 --- a/java/javax/servlet/ServletContext.java +++ b/java/javax/servlet/ServletContext.java @@ -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 servletClass); @@ -696,6 +700,7 @@ public interface ServletContext { * @return * @throws ServletException * @since Servlet 3.0 + * TODO SERVLET3 - Add comments */ public T createServlet(Class 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 filterClass); @@ -755,6 +764,7 @@ public interface ServletContext { * @return * @throws ServletException * @since Servlet 3.0 + * TODO SERVLET3 - Add comments */ public T createFilter(Class 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 sessionTrackingModes) @@ -794,14 +807,16 @@ public interface ServletContext { /** * * @return - * @since 3.0 + * @since Servlet 3.0 + * TODO SERVLET3 - Add comments */ public EnumSet getDefaultSessionTrackingModes(); /** * * @return - * @since 3.0 + * @since Servlet 3.0 + * TODO SERVLET3 - Add comments */ public EnumSet getEffectiveSessionTrackingModes(); diff --git a/java/javax/servlet/ServletRegistration.java b/java/javax/servlet/ServletRegistration.java index da2157835..3de9935c6 100644 --- a/java/javax/servlet/ServletRegistration.java +++ b/java/javax/servlet/ServletRegistration.java @@ -19,7 +19,7 @@ package javax.servlet; import java.util.Set; /** - * @since 3.0 + * @since Servlet 3.0 * $Id$ * TODO SERVLET3 - Add comments */ diff --git a/java/javax/servlet/ServletRequest.java b/java/javax/servlet/ServletRequest.java index 7045e687c..8d6873b8d 100644 --- a/java/javax/servlet/ServletRequest.java +++ b/java/javax/servlet/ServletRequest.java @@ -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(); } diff --git a/java/javax/servlet/ServletRequestWrapper.java b/java/javax/servlet/ServletRequestWrapper.java index f86ead2d1..755a9655d 100644 --- a/java/javax/servlet/ServletRequestWrapper.java +++ b/java/javax/servlet/ServletRequestWrapper.java @@ -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 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(); diff --git a/java/javax/servlet/ServletResponseWrapper.java b/java/javax/servlet/ServletResponseWrapper.java index 371f123f3..f1442109d 100644 --- a/java/javax/servlet/ServletResponseWrapper.java +++ b/java/javax/servlet/ServletResponseWrapper.java @@ -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 wrappedType) { if (wrappedType.isAssignableFrom(response.getClass())) { diff --git a/java/javax/servlet/SessionTrackingMode.java b/java/javax/servlet/SessionTrackingMode.java index fcb49afc1..8821ba8b9 100644 --- a/java/javax/servlet/SessionTrackingMode.java +++ b/java/javax/servlet/SessionTrackingMode.java @@ -17,7 +17,7 @@ package javax.servlet; /** - * @since 3.0 + * @since Servlet 3.0 * $Id$ */ public enum SessionTrackingMode { diff --git a/java/javax/servlet/annotation/HandlesTypes.java b/java/javax/servlet/annotation/HandlesTypes.java index 3a48f3dd6..82ec9f663 100644 --- a/java/javax/servlet/annotation/HandlesTypes.java +++ b/java/javax/servlet/annotation/HandlesTypes.java @@ -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) diff --git a/java/javax/servlet/annotation/WebFilter.java b/java/javax/servlet/annotation/WebFilter.java index 42f8eb5a0..a3946a467 100644 --- a/java/javax/servlet/annotation/WebFilter.java +++ b/java/javax/servlet/annotation/WebFilter.java @@ -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) diff --git a/java/javax/servlet/annotation/WebInitParam.java b/java/javax/servlet/annotation/WebInitParam.java index f0c8cf16f..b77ac4667 100644 --- a/java/javax/servlet/annotation/WebInitParam.java +++ b/java/javax/servlet/annotation/WebInitParam.java @@ -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) diff --git a/java/javax/servlet/annotation/WebServlet.java b/java/javax/servlet/annotation/WebServlet.java index d8593ea8f..3f3b3867e 100644 --- a/java/javax/servlet/annotation/WebServlet.java +++ b/java/javax/servlet/annotation/WebServlet.java @@ -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) diff --git a/java/javax/servlet/http/Cookie.java b/java/javax/servlet/http/Cookie.java index bd85198d6..f174eadd0 100644 --- a/java/javax/servlet/http/Cookie.java +++ b/java/javax/servlet/http/Cookie.java @@ -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; diff --git a/java/javax/servlet/http/HttpServletResponse.java b/java/javax/servlet/http/HttpServletResponse.java index 1df15c7e1..0a9bf62f2 100644 --- a/java/javax/servlet/http/HttpServletResponse.java +++ b/java/javax/servlet/http/HttpServletResponse.java @@ -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 getHeaders(String name); @@ -352,6 +355,7 @@ public interface HttpServletResponse extends ServletResponse { * * @return * @since Servlet 3.0 + * TODO SERVLET3 - Add comments */ public Iterable getHeaderNames(); diff --git a/java/javax/servlet/http/HttpServletResponseWrapper.java b/java/javax/servlet/http/HttpServletResponseWrapper.java index fe35971ea..f003e4bb5 100644 --- a/java/javax/servlet/http/HttpServletResponseWrapper.java +++ b/java/javax/servlet/http/HttpServletResponseWrapper.java @@ -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 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 getHeaderNames() { return this._getHttpServletResponse().getHeaderNames(); diff --git a/java/javax/servlet/http/Part.java b/java/javax/servlet/http/Part.java index 5db774486..7f9ca5074 100644 --- a/java/javax/servlet/http/Part.java +++ b/java/javax/servlet/http/Part.java @@ -21,6 +21,7 @@ import java.io.InputStream; /** * @since Servlet 3.0 + * TODO SERVLET3 - Add comments */ public interface Part { public InputStream getInputStream() throws IOException;