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

[weld-commits at lists.jboss.org]

Author: gavin.king at jboss.com
Date: 2009-10-29 00:48:47 -0400 (Thu, 29 Oct 2009)
New Revision: 4379

Modified:
   api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Bean.java
   api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Decorator.java
   api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Interceptor.java
Log:
bit more consistency

Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Bean.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Bean.java	2009-10-29 04:34:29 UTC (rev 4378)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Bean.java	2009-10-29 04:48:47 UTC (rev 4379)
@@ -24,11 +24,10 @@
 import javax.enterprise.context.spi.Contextual;
 
 /**
- * <p>
- * This interface defines everything the container needs to manage instances of
- * a certain bean.
- * </p>
+ * <p>Represents an enabled bean. This interface defines everything 
+ * the container needs to manage instances of the bean.</p>
  * 
+ * @author Gavin King
  * @author David Allen
  * @param <T> the class of the bean instance
  */

Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Decorator.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Decorator.java	2009-10-29 04:34:29 UTC (rev 4378)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Decorator.java	2009-10-29 04:48:47 UTC (rev 4379)
@@ -22,33 +22,35 @@
 import java.util.Set;
 
 /**
- * The bean object for a decorator must implement this interface.
+ * <p>Represents an enabled decorator.</p>
  * 
+ * @author Gavin King
  * @author Pete Muir
  *
- * @param <T> the decorator type
+ * @param <T> the decorator bean class
  */
 public interface Decorator<T> extends Bean<T>
 {
 
    /**
-    * Obtains the delegate {@linkplain Type type}.
+    * <p>Get the delegate type</p>
     * 
-    * @return the delegate {@linkplain Type type}
+    * @return the delegate type
     */
    public Type getDelegateType();
 
    /**
-    * Obtains the {@linkplain javax.inject.Qualifier qualifiers} of the delegate.
+    * <p>Get the {@linkplain javax.inject.Qualifier qualifiers} of the delegate
+    * injection point.</p>
     * 
-    * @return the {@linkplain javax.inject.Qualifier qualifiers} of the delegate
+    * @return the delegate qualifiers
     */
    public Set<Annotation> getDelegateQualifiers();
    
    /**
-    * Obtains the decorated {@linkplain Type types} of the decorator
+    * <p>Get the decorated types.</p>
     * 
-    * @return the set of decorated {@linkplain Type types} of the decorator
+    * @return the set of decorated types
     */
    public Set<Type> getDecoratedTypes();
 

Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Interceptor.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Interceptor.java	2009-10-29 04:34:29 UTC (rev 4378)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Interceptor.java	2009-10-29 04:48:47 UTC (rev 4379)
@@ -23,38 +23,40 @@
 import javax.interceptor.InvocationContext;
 
 /**
- * Main interface for all Bean objects representing an interceptor.
+ * <p>Represents an enabled interceptor.</p>
  * 
  * @author Gavin King
  * @author Pete Muir
  * @author David Allen
  *
- * @param <T> the {@link java.lang.Class} of bean intercepted
+ * @param <T> the interceptor bean class
  */
 public interface Interceptor<T> extends Bean<T>
 {
 
    /**
-    * Returns the set of interceptor bindings used to bind an interceptor to a bean.
+    * <p>Get the interceptor bindings of the interceptor.</p>
     * 
-    * @return the interceptor bindings
+    * @return the set of interceptor bindings
     */
    public Set<Annotation> getInterceptorBindingTypes();
    
    /**
-    * Tests if this intercepts callbacks or business methods of the given type.
+    * <p>Determines if the interceptor intercepts callbacks or business methods of 
+    * the given type.</p>
     * 
-    * @param type The type of interception
-    * @return true if this intercepts the given type of methods
+    * @param type the type of interception
+    * @return  returns <tt>true</tt> if the interceptor intercepts callbacks 
+    * or business methods of the given type, and <tt>false</tt> otherwise.
     */
    public boolean intercepts(InterceptionType type); 
    
    /**
-    * Invokes the specified kind of lifecycle callback or business method upon the 
-    * given instance.
+    * <p>Invokes the specified kind of lifecycle callback or business method upon the 
+    * given interceptor instance.</p>
     * 
     * @param type the interception type
-    * @param instance the instance to invoke
+    * @param instance the interceptor instance to invoke
     * @param ctx the context for the invocation
     * @return the return value from the invocation
     */