[weld-commits] Weld SVN: r4339 - api/trunk/cdi/src/main/java/javax/enterprise/inject/spi.

[weld-commits at lists.jboss.org]

Author: dallen6
Date: 2009-10-26 15:23:31 -0400 (Mon, 26 Oct 2009)
New Revision: 4339

Modified:
   api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/InjectionTarget.java
Log:
Added JavaDoc for Producer

Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/InjectionTarget.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/InjectionTarget.java	2009-10-26 18:14:09 UTC (rev 4338)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/InjectionTarget.java	2009-10-26 19:23:31 UTC (rev 4339)
@@ -19,19 +19,50 @@
 import javax.enterprise.context.spi.CreationalContext;
 
 /**
+ * <p>
+ * This interface provides operations for performing dependency injection and
+ * lifecycle callbacks on an instance of a type.
+ * </p>
  * 
- * 
  * @author Pete Muir
- *
- * @param <T>
+ * @author David Allen
+ * @param <T> The class of the instance
  */
 public interface InjectionTarget<T> extends Producer<T>
 {
 
+   /**
+    * <p>
+    * Performs dependency injection upon the given object. First, the container
+    * performs Java EE component environment injection according to the
+    * semantics required by the Java EE platform specification. Next, it sets
+    * the value of all injected fields, and then calls all initializer methods.
+    * </p>
+    * 
+    * @param instance The instance upon which to perform injections
+    * @param ctx The CreationalContext to use for creating new instances
+    */
    public void inject(T instance, CreationalContext<T> ctx);
 
+   /**
+    * <p>
+    * Calls the {@link javax.annotation.PostConstruct} callback, if it exists,
+    * according to the semantics required by the Java EE platform specification.
+    * </p>
+    * 
+    * @param instance
+    */
    public void postConstruct(T instance);
 
+   /**
+    * <p>
+    * Calls the {@link javax.annotation.PreDestroy} callback, if it exists,
+    * according to the semantics required by the Java EE platform specification.
+    * </p>
+    * 
+    * @param instance The instance on which to invoke the
+    *           {@link javax.annotation.PreDestroy} method
+    */
    public void preDestroy(T instance);
 
 }