This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 7.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/7.0.x by this push:
new b048600 Polish. Align with 8.5.x. Improve Java doc.
b048600 is described below
commit b0486003b5f65f4e823d7a70e81905f1ea572252
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Mon Jul 22 12:12:40 2019 +0100
Polish. Align with 8.5.x. Improve Java doc.
---
java/javax/servlet/Filter.java | 31 ++++++++++++++++++++++++-------
1 file changed, 24 insertions(+), 7 deletions(-)
diff --git a/java/javax/servlet/Filter.java b/java/javax/servlet/Filter.java
index b36b37d..fec7e0a 100644
--- a/java/javax/servlet/Filter.java
+++ b/java/javax/servlet/Filter.java
@@ -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;
@@ -96,5 +114,4 @@ public interface Filter {
* state in memory.
*/
public void destroy();
-
}
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
