Author: markt
Date: Mon Oct 13 22:36:45 2014
New Revision: 1631593
URL: http://svn.apache.org/r1631593
Log:
Fix some Javadoc warnings when compiling with Java 8
Modified:
tomcat/trunk/java/javax/servlet/Filter.java
tomcat/trunk/java/javax/servlet/FilterChain.java
tomcat/trunk/java/javax/servlet/FilterConfig.java
tomcat/trunk/java/javax/servlet/FilterRegistration.java
tomcat/trunk/java/javax/servlet/ServletContext.java
Modified: tomcat/trunk/java/javax/servlet/Filter.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/Filter.java?rev=1631593&r1=1631592&r2=1631593&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/Filter.java (original)
+++ tomcat/trunk/java/javax/servlet/Filter.java Mon Oct 13 22:36:45 2014
@@ -49,12 +49,20 @@ public interface Filter {
* Called by the web container to indicate to a filter that it is being
* placed into service. The servlet container calls the init method exactly
* once after instantiating the filter. The init method must complete
- * successfully before the filter is asked to do any filtering work. <br>
- * <br>
+ * successfully before the filter is asked to do any filtering work.
+ * <p>
* The web container cannot place the filter into service if the init
method
- * either<br>
- * 1.Throws a ServletException <br>
- * 2.Does not return within a time period defined by the web container
+ * either:
+ * <ul>
+ * <li>Throws a ServletException</li>
+ * <li>Does not return within a time period defined by the web
+ * container</li>
+ * </ul>
+ *
+ * @param filterConfig The configuration information associated with the
+ * filter instance being initialised
+ *
+ * @throws ServletException if the initialisation fails
*/
public void init(FilterConfig filterConfig) throws ServletException;
@@ -78,7 +86,17 @@ public interface Filter {
* next entity in the filter chain to block the request processing<br>
* 5. Directly set headers on the response after invocation of the next
* entity in the filter chain.
- **/
+ *
+ * @param request The request to process
+ * @param response The response associated with the request
+ * @param chain Provides access to the next filter in the chain for this
+ * filter to pass the request and response to for further
+ * processing
+ *
+ * @throws IOException if an I/O error occurs during this filter's
+ * processing of the request
+ * @throws ServletException if the processing fails for any other reason
+ */
public void doFilter(ServletRequest request, ServletResponse response,
FilterChain chain) throws IOException, ServletException;
Modified: tomcat/trunk/java/javax/servlet/FilterChain.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/FilterChain.java?rev=1631593&r1=1631592&r2=1631593&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/FilterChain.java (original)
+++ tomcat/trunk/java/javax/servlet/FilterChain.java Mon Oct 13 22:36:45 2014
@@ -41,6 +41,10 @@ public interface FilterChain {
* @param response
* the response to pass along the chain.
*
+ * @throws IOException if an I/O error occurs during the processing of the
+ * request
+ * @throws ServletException if the processing fails for any other reason
+
* @since 2.3
*/
public void doFilter(ServletRequest request, ServletResponse response)
Modified: tomcat/trunk/java/javax/servlet/FilterConfig.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/FilterConfig.java?rev=1631593&r1=1631592&r2=1631593&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/FilterConfig.java (original)
+++ tomcat/trunk/java/javax/servlet/FilterConfig.java Mon Oct 13 22:36:45 2014
@@ -30,8 +30,10 @@ import java.util.Enumeration;
public interface FilterConfig {
/**
- * Returns the filter-name of this filter as defined in the deployment
- * descriptor.
+ * Get the name of the filter.
+ *
+ * @return The filter-name of this filter as defined in the deployment
+ * descriptor.
*/
public String getFilterName();
Modified: tomcat/trunk/java/javax/servlet/FilterRegistration.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/FilterRegistration.java?rev=1631593&r1=1631592&r2=1631593&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/FilterRegistration.java (original)
+++ tomcat/trunk/java/javax/servlet/FilterRegistration.java Mon Oct 13 22:36:45
2014
@@ -26,12 +26,19 @@ import java.util.EnumSet;
public interface FilterRegistration extends Registration {
/**
+ * Add a mapping for this filter to one or more named Servlets.
*
- * @param dispatcherTypes
- * @param isMatchAfter
- * @param servletNames
- * @throws IllegalArgumentException
- * @throws IllegalStateException
+ * @param dispatcherTypes The dispatch types to which this filter should
+ * apply
+ * @param isMatchAfter Should this filter be applied after any mappings
+ * defined in the deployment descriptor
+ * (<code>true</code>) or before?
+ * @param servletNames Requests mapped to these servlets will be
+ * processed by this filter
+ * @throws IllegalArgumentException if the list of sevrlet names is empty
+ * or null
+ * @throws IllegalStateException if the associated ServletContext has
+ * already been initialised
*/
public void addMappingForServletNames(
EnumSet<DispatcherType> dispatcherTypes,
@@ -43,12 +50,19 @@ public interface FilterRegistration exte
public Collection<String> getServletNameMappings();
/**
+ * Add a mapping for this filter to one or more URL patterns.
*
- * @param dispatcherTypes
- * @param isMatchAfter
- * @param urlPatterns
- * @throws IllegalArgumentException
- * @throws IllegalStateException
+ * @param dispatcherTypes The dispatch types to which this filter should
+ * apply
+ * @param isMatchAfter Should this filter be applied after any mappings
+ * defined in the deployment descriptor
+ * (<code>true</code>) or before?
+ * @param urlPatterns The URL patterns to which this filter should be
+ * applied
+ * @throws IllegalArgumentException if the list of URL patterns is empty or
+ * null
+ * @throws IllegalStateException if the associated ServletContext has
+ * already been initialised
*/
public void addMappingForUrlPatterns(
EnumSet<DispatcherType> dispatcherTypes,
Modified: tomcat/trunk/java/javax/servlet/ServletContext.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletContext.java?rev=1631593&r1=1631592&r2=1631593&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletContext.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletContext.java Mon Oct 13 22:36:45 2014
@@ -436,10 +436,14 @@ public interface ServletContext {
public Enumeration<String> getInitParameterNames();
/**
- * @param name
- * @param value
- * @return TODO
- * @throws IllegalStateException
+ * Set the given initialisation parameter to the given value.
+ * @param name Name of initialisation parameter
+ * @param value Value for initialisation parameter
+ * @return <code>true</code> if the call succeeds or <code>false</code> if
+ * the call fails because an initialisation parameter with the same
+ * name has already been set
+ * @throws IllegalStateException If initialisation of this ServletContext
+ * has already completed
* @throws UnsupportedOperationException If called from a
* {@link
ServletContextListener#contextInitialized(ServletContextEvent)}
* method of a {@link ServletContextListener} that was not defined in a
@@ -447,7 +451,7 @@ public interface ServletContext {
* {@link javax.servlet.annotation.WebListener}. For example, a
* {@link ServletContextListener} defined in a TLD would not be able to
* use this method.
- * @since Servlet 3.0 TODO SERVLET3 - Add comments
+ * @since Servlet 3.0
*/
public boolean setInitParameter(String name, String value);
@@ -530,9 +534,10 @@ public interface ServletContext {
public String getServletContextName();
/**
- * @param servletName
- * @param className
- * @return TODO
+ * Register a servlet implementation for use in this ServletContext.
+ * @param servletName The name of the servlet to register
+ * @param className The implementation class for the servlet
+ * @return The registration object that enables further configuration
* @throws IllegalStateException
* If the context has already been initialised
* @throws UnsupportedOperationException If called from a
@@ -542,15 +547,16 @@ public interface ServletContext {
* {@link javax.servlet.annotation.WebListener}. For example, a
* {@link ServletContextListener} defined in a TLD would not be able to
* use this method.
- * @since Servlet 3.0 TODO SERVLET3 - Add comments
+ * @since Servlet 3.0
*/
public ServletRegistration.Dynamic addServlet(String servletName,
String className);
/**
- * @param servletName
- * @param servlet
- * @return TODO
+ * Register a servlet instance for use in this ServletContext.
+ * @param servletName The name of the servlet to register
+ * @param servlet The Servlet instance to register
+ * @return The registration object that enables further configuration
* @throws IllegalStateException
* If the context has already been initialised
* @throws UnsupportedOperationException If called from a
@@ -560,7 +566,7 @@ public interface ServletContext {
* {@link javax.servlet.annotation.WebListener}. For example, a
* {@link ServletContextListener} defined in a TLD would not be able to
* use this method.
- * @since Servlet 3.0 TODO SERVLET3 - Add comments
+ * @since Servlet 3.0
*/
public ServletRegistration.Dynamic addServlet(String servletName,
Servlet servlet);
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
