Author: dallen6
Date: 2009-10-25 11:08:23 -0400 (Sun, 25 Oct 2009)
New Revision: 4298
Modified:
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/BeforeBeanDiscovery.java
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/BeforeShutdown.java
Log:
Updated some lifecycle events to match final spec; added JavaDoc.
Modified:
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/BeforeBeanDiscovery.java
===================================================================
---
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/BeforeBeanDiscovery.java 2009-10-25
14:59:06 UTC (rev 4297)
+++
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/BeforeBeanDiscovery.java 2009-10-25
15:08:23 UTC (rev 4298)
@@ -19,19 +19,64 @@
import java.lang.annotation.Annotation;
/**
+ * <p>
+ * This event type is thrown by the container before the bean discovery process
+ * begins. If any observer method of the {@code BeforeBeanDiscovery} event
+ * throws an exception, the exception is treated as a definition error by the
+ * container.
+ * </p>
*
* @author Pete Muir
- *
+ * @author David Allen
*/
public interface BeforeBeanDiscovery
{
- public void addQualifier(Class<? extends Annotation> bindingType);
+ /**
+ * Declares an annotation type as a {@linkplain javax.inject.Qualifier}
+ * qualifier type.
+ *
+ * @param qualifier The annotation to treat as a qualifier
+ */
+ public void addQualifier(Class<? extends Annotation> qualifier);
+ /**
+ * Declares an annotation type as a {@linkplain javax.enterprise.context
+ * scope type}.
+ *
+ * @param scopeType The annotation type to treat as a
+ * {@linkplain javax.enterprise.context scope type}
+ * @param normal Indicates if the scope is normal
+ * @param passivating Indicates if the scope is passivation capable
+ */
public void addScope(Class<? extends Annotation> scopeType, boolean normal,
boolean passivating);
+ /**
+ * Declares an annotation type as a
+ * {@linkplain javax.enterprise.inject.Stereotype stereotype}, and specifies
+ * its meta-annotations.
+ *
+ * @param stereotype The annotation type to treat as a
+ * {@linkplain javax.enterprise.inject.Stereotype stereotype}
+ * @param stereotypeDef An optional list of annotations defining the
+ * {@linkplain javax.enterprise.inject.Stereotype stereotype}
+ */
public void addStereotype(Class<? extends Annotation> stereotype, Annotation...
stereotypeDef);
- public void addInterceptorBindingType(Class<? extends Annotation> bindingType);
-
+ /**
+ * Declares an annotation type as an {@linkplain Interceptor interceptor}
+ * binding type, and specifies its meta-annotations.
+ *
+ * @param bindingType The annotation type to treat as an interceptor binding
+ * type
+ */
+ public void addInterceptorBinding(Class<? extends Annotation> bindingType);
+
+ /**
+ * Adds a given {@link javax.enterprise.inject.spi.AnnotatedType} to the set
+ * of types which will be scanned during bean discovery.
+ *
+ * @param type The {@link javax.enterprise.inject.spi.AnnotatedType} to add
+ * for later scanning
+ */
public void addAnnotatedType(AnnotatedType<?> type);
}
Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/BeforeShutdown.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/BeforeShutdown.java 2009-10-25
14:59:06 UTC (rev 4297)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/BeforeShutdown.java 2009-10-25
15:08:23 UTC (rev 4298)
@@ -16,6 +16,16 @@
*/
package javax.enterprise.inject.spi;
+/**
+ * <p>
+ * The type of final event the container fires after it has finished processing
+ * requests and destroyed all contexts. If any observer method of the
+ * {@code BeforeShutdown} event throws an exception, the exception is ignored by the
+ * container.
+ * </p>
+ *
+ * @author David Allen
+ */
public interface BeforeShutdown
{
}
Show replies by date