Author: markt
Date: Tue Nov 27 10:06:42 2012
New Revision: 1414053
URL: http://svn.apache.org/viewvc?rev=1414053&view=rev
Log:
Populate the SCI Javadoc
Modified:
tomcat/trunk/java/javax/servlet/ServletContainerInitializer.java
Modified: tomcat/trunk/java/javax/servlet/ServletContainerInitializer.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletContainerInitializer.java?rev=1414053&r1=1414052&r2=1414053&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletContainerInitializer.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletContainerInitializer.java Tue Nov 27
10:06:42 2012
@@ -19,18 +19,35 @@ package javax.servlet;
import java.util.Set;
/**
+ * ServletContainerInitializers (SCIs) are registered via an entry in the
+ * file META-INF/services/javax.servlet.ServletContainerInitializer that must
be
+ * included in the JAR file that contains the SCI implementation.
+ * <p>
+ * SCIs processing is performed regardless of the setting of metadata-complete.
+ * SCI processing can be controlled be JAR file via fragment ordering. If an
+ * absolute ordering is defined, the only those fragments included in the
+ * ordering will be scanned. To disable SCI processing completely, an empty
+ * absolute ordering may be defined.
+ * <p>
+ * SCIs register an interest in annotations (class, method or field) or types
+ * via the {@link javax.servlet.annotation.HandlesTypes} annotation which is
+ * added to the {@link #onStartup(Set, ServletContext)} method.
+ *
* @since Servlet 3.0
- * $Id$
- * TODO SERVLET3 - Add comments
*/
public interface ServletContainerInitializer {
/**
+ * Receives notification during startup of a web application of the classes
+ * within the web application that matched the criteria defined via the
+ * {@link javax.servlet.annotation.HandlesTypes} annotation.
*
- * @param c
- * @param ctx
- * @throws ServletException
+ * @param c The (possibly null) set of classes that met the specified
+ * criteria
+ * @param ctx The ServletContext of the web application in which the
+ * classes were discovered
+ *
+ * @throws ServletException If an error occurs
*/
- public void onStartup(Set<Class<?>> c, ServletContext ctx)
- throws ServletException;
+ void onStartup(Set<Class<?>> c, ServletContext ctx) throws
ServletException;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
