Weld SVN: r4381 - api/trunk/cdi/src/main/java/javax/enterprise/inject/spi.
by weld-commits＠lists.jboss.org
Author: gavin.king(a)jboss.com
Date: 2009-10-29 00:57:00 -0400 (Thu, 29 Oct 2009)
New Revision: 4381
Modified:
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/ObserverMethod.java
Log:
minor
Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/ObserverMethod.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/ObserverMethod.java 2009-10-29 04:54:40 UTC (rev 4380)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/ObserverMethod.java 2009-10-29 04:57:00 UTC (rev 4381)
@@ -26,17 +26,16 @@
public Class<X> getBeanClass();
/**
- * Obtains the {@linkplain Type type} of event being observed.
+ * Obtains the observed event {@linkplain Type type}.
*
- * @return the event {@linkplain Type type}
+ * @return the observed event {@linkplain Type type}
*/
public Type getObservedType();
/**
- * Obtains the set of {@linkplain javax.inject.Qualifier qualifiers} for the
- * event being observed.
+ * Obtains the set of observed event {@linkplain javax.inject.Qualifier qualifiers}.
*
- * @return the {@linkplain javax.inject.Qualifier qualifiers} for the event
+ * @return the observed event {@linkplain javax.inject.Qualifier qualifiers}
*/
public Set<Annotation> getObservedQualifiers();
@@ -58,7 +57,7 @@
/**
* Calls the observer method passing the given event object.
*
- * @param event The event object
+ * @param event the event object
*/
public void notify(T event);
}
15 years, 1 month
Weld SVN: r4380 - api/trunk/cdi/src/main/java/javax/enterprise/inject/spi.
by weld-commits＠lists.jboss.org
Author: gavin.king(a)jboss.com
Date: 2009-10-29 00:54:40 -0400 (Thu, 29 Oct 2009)
New Revision: 4380
Modified:
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Decorator.java
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Interceptor.java
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/ObserverMethod.java
Log:
hrm, roll back
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:48:47 UTC (rev 4379)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Decorator.java 2009-10-29 04:54:40 UTC (rev 4380)
@@ -33,24 +33,24 @@
{
/**
- * <p>Get the delegate type</p>
+ * <p>Obtains the delegate {@linkplain Type type}.</p>
*
- * @return the delegate type
+ * @return the delegate {@linkplain Type type}
*/
public Type getDelegateType();
/**
- * <p>Get the {@linkplain javax.inject.Qualifier qualifiers} of the delegate
+ * <p>Obtains the {@linkplain javax.inject.Qualifier qualifiers} of the delegate
* injection point.</p>
*
- * @return the delegate qualifiers
+ * @return the delegate {@linkplain javax.inject.Qualifier qualifiers}
*/
public Set<Annotation> getDelegateQualifiers();
/**
- * <p>Get the decorated types.</p>
+ * <p>Obtains the decorated {@linkplain Type types}.</p>
*
- * @return the set of decorated types
+ * @return the set of decorated {@linkplain Type 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:48:47 UTC (rev 4379)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Interceptor.java 2009-10-29 04:54:40 UTC (rev 4380)
@@ -35,9 +35,10 @@
{
/**
- * <p>Get the interceptor bindings of the interceptor.</p>
+ * <p>Obtains the {@linkplain javax.interceptor.InterceptorBinding interceptor bindings}
+ * of the interceptor.</p>
*
- * @return the set of interceptor bindings
+ * @return the set of {@linkplain javax.interceptor.InterceptorBinding interceptor bindings}
*/
public Set<Annotation> getInterceptorBindingTypes();
Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/ObserverMethod.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/ObserverMethod.java 2009-10-29 04:48:47 UTC (rev 4379)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/ObserverMethod.java 2009-10-29 04:54:40 UTC (rev 4380)
@@ -8,14 +8,13 @@
import javax.enterprise.event.TransactionPhase;
/**
- * <p>
- * This interface defines everything the container needs to know about an
- * observer method.
- * </p>
+ * <p>Represents an observer method of an enabled bean. Defines
+ * everything the container needs to know about an observer method.</p>
*
+ * @author Gavin King
* @author David Allen
- * @param <X> the type of bean with the observer method
- * @param <T> the type of event
+ * @param <X> the type of the bean with the observer method
+ * @param <T> the event type
*/
public interface ObserverMethod<X, T>
{
15 years, 1 month
Weld SVN: r4379 - api/trunk/cdi/src/main/java/javax/enterprise/inject/spi.
by weld-commits＠lists.jboss.org
Author: gavin.king(a)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
*/
15 years, 1 month
Weld SVN: r4378 - api/trunk/cdi/src/main/java/javax/enterprise/inject/spi.
by weld-commits＠lists.jboss.org
Author: gavin.king(a)jboss.com
Date: 2009-10-29 00:34:29 -0400 (Thu, 29 Oct 2009)
New Revision: 4378
Modified:
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/BeanManager.java
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Extension.java
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/package-info.java
Log:
Done with the preamble, etc.
Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/BeanManager.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/BeanManager.java 2009-10-29 04:02:56 UTC (rev 4377)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/BeanManager.java 2009-10-29 04:34:29 UTC (rev 4378)
@@ -32,36 +32,24 @@
import javax.enterprise.inject.UnsatisfiedResolutionException;
/**
- * <p>
- * This interface provides operations for obtaining contextual references for
- * beans, along with many other operations of use to portable extensions.
- * Occasionally it is necessary to use this programmatic API to fully utilize
- * portable extensions in the Contexts and Dependency Injection for the Java EE
- * platform standard.
- * </p>
- * <p>
- * The container provides a built-in bean with bean type BeanManager, scope
- * {@literal @}{@link javax.enterprise.context.Dependent} and qualifier
- * {@literal @}{@link javax.enterprise.inject.Default}. The built-in
- * implementation is a {@linkplain PassivationCapable passivation capable}
- * dependency. Thus, any bean may obtain an instance of BeanManager by injecting
- * it:
- * </p>
+ * <p>Allows a portable extension to interact directly with the container.
+ * Provides operations for obtaining contextual references for beans, along
+ * with many other operations of use to portable extensions.</p>
*
+ * <p>Any bean may obtain an instance of <tt>BeanManager</tt> by injecting
+ * it:</p>
+ *
* <pre>
- * @Inject
- * BeanManager manager;
+ * @Inject BeanManager manager;
* </pre>
- * <p>
- * Java EE components may also obtain an instance of BeanManager from
+ *
+ * <p>Java EE components may obtain an instance of <tt>BeanManager</tt> from
* {@linkplain javax.naming JNDI} by looking up the name {@code
- * java:comp/BeanManager}.
- * </p>
- * <p>
- * Any operation of BeanManager may be called at any time during the execution
- * of the application.
- * </p>
+ * java:comp/BeanManager}.</p>
*
+ * <p>Any operation of <tt>BeanManager</tt> may be called at any time during
+ * the execution of the application.</p>
+ *
* @author Gavin King
* @author Pete Muir
* @author Clint Popetz
Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Extension.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Extension.java 2009-10-29 04:02:56 UTC (rev 4377)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Extension.java 2009-10-29 04:34:29 UTC (rev 4378)
@@ -18,7 +18,24 @@
package javax.enterprise.inject.spi;
/**
+ * <p>Service interface implemented by service providers that
+ * observe container lifecycle events. Service providers must
+ * be declared in <tt>META-INF/services</tt></p>
*
+ * <p>The container instantiates a single instance of each
+ * service provider at the beginning of the application
+ * initialization process and maintains a reference to it until
+ * the application shuts down.</p>
+ *
+ * <p>Service providers may have observer methods, which may
+ * observe container initialization events and obtain an injected
+ * {@link javax.enterprise.inject.spi.BeanManager}.<p>
+ *
+ * <p>Service providers are made available for injection as beans
+ * with the qualifier {@link javax.context.Default @Default}.</p>
+ *
+ *
+ * @author Gavin King
* @author Pete Muir
*
*/
Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/package-info.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/package-info.java 2009-10-29 04:02:56 UTC (rev 4377)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/package-info.java 2009-10-29 04:34:29 UTC (rev 4378)
@@ -1,6 +1,43 @@
/**
* <p>The portable extension integration SPI.</p>
*
+ * <p>A portable extension may integrate with the container by:</p>
+ *
+ * <ul>
+ * <li>Providing its own beans, interceptors and decorators to the
+ * container</li>
+ * <li>Injecting dependencies into its own objects using the
+ * dependency injection service</li>
+ * <li>Providing a context implementation for a custom scope</li>
+ * <li>Augmenting or overriding the annotation-based metadata with
+ * metadata from some other source</li>
+ * </ul>
+ *
+ * <h3>Interfaces representing enabled beans</h3>
+ *
+ * <p>The interfaces
+ * {@link javax.enterprise.inject.spi.Bean},
+ * {@link javax.enterprise.inject.spi.Decorator},
+ * {@link javax.enterprise.inject.spi.Interceptor} and
+ * {@link javax.enterprise.inject.spi.ObserverMethod}
+ * define everything the container needs to manage instances of
+ * a bean, interceptor, decorator or observer method.</p>
+ *
+ * <p>An instance of <tt>Bean</tt> exists for every
+ * {@linkplain javax.enterprise.inject enabled bean}. An application
+ * or portable extension may add support for new kinds of beans by
+ * implementing <tt>Bean</tt> and
+ * {@linkplain javax.enterprise.inject.spi.AfterBeanDiscovery#addBean(Bean)
+ * registering beans} with the container.</p>
+ *
+ * <h3>The <tt>BeanManager</tt> object</h3>
+ *
+ * <p>Portable extensions sometimes interact directly with the container
+ * via programmatic API call. The interface
+ * {@link javax.enterprise.inject.spi.BeanManager} provides operations
+ * for obtaining contextual references for beans, along with many other
+ * operations of use to portable extensions.</p>
+ *
* <h3>Alternate metadata sources</h3>
*
* <p>A portable extension may provide an alternative metadata
@@ -15,5 +52,14 @@
* element types and annotations, instead of directly calling the
* Java Reflection API.</p>
*
+ * <h3>Container lifecycle events</h3>
+ *
+ * <p>During the application initialization process, the container fires
+ * a series of events, allowing portable extensions to integrate with the
+ * container initialization process. Observers of these events must be
+ * service providers of the service
+ * {@link javax.enterprise.inject.spi.Extension} declared in
+ * <tt>META-INF/services</tt>.</p>
+ *
*/
package javax.enterprise.inject.spi;
\ No newline at end of file
15 years, 1 month
Weld SVN: r4377 - api/trunk/cdi/src/main/java/javax/enterprise/inject/spi.
by weld-commits＠lists.jboss.org
Author: gavin.king(a)jboss.com
Date: 2009-10-29 00:02:56 -0400 (Thu, 29 Oct 2009)
New Revision: 4377
Modified:
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/package-info.java
Log:
ws
Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/package-info.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/package-info.java 2009-10-29 04:02:38 UTC (rev 4376)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/package-info.java 2009-10-29 04:02:56 UTC (rev 4377)
@@ -15,6 +15,5 @@
* element types and annotations, instead of directly calling the
* Java Reflection API.</p>
*
-
*/
package javax.enterprise.inject.spi;
\ No newline at end of file
15 years, 1 month
Weld SVN: r4376 - api/trunk/cdi/src/main/java/javax/enterprise/inject/spi.
by weld-commits＠lists.jboss.org
Author: gavin.king(a)jboss.com
Date: 2009-10-29 00:02:38 -0400 (Thu, 29 Oct 2009)
New Revision: 4376
Added:
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/package-info.java
Modified:
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Annotated.java
Log:
move blurb to package-level doc
Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Annotated.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Annotated.java 2009-10-29 03:56:24 UTC (rev 4375)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Annotated.java 2009-10-29 04:02:38 UTC (rev 4376)
@@ -24,17 +24,6 @@
/**
* <p>Represents a Java program element that can be annotated.<p>
*
- * <p>A portable extension may provide an alternative metadata
- * source, such as configuration by XML. <tt>Annotated</tt>
- * and its subtypes allow a portable extension to specify
- * metadata that overrides the annotations that exist on a
- * bean class. The portable extension is responsible for
- * implementing the interfaces, thereby exposing the metadata
- * to the container. The container must use the operations of
- * <tt>Annotated</tt> and its subinterfaces to discover program
- * element types and annotations, instead of directly calling the
- * Java Reflection API.</p>
- *
* @see java.lang.reflect.AnnotatedElement
*
* @author Gavin King
Added: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/package-info.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/package-info.java (rev 0)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/package-info.java 2009-10-29 04:02:38 UTC (rev 4376)
@@ -0,0 +1,20 @@
+/**
+ * <p>The portable extension integration SPI.</p>
+ *
+ * <h3>Alternate metadata sources</h3>
+ *
+ * <p>A portable extension may provide an alternative metadata
+ * source, such as configuration by XML.
+ * {@link javax.enterprise.inject.spi.Annotated}
+ * and its subtypes allow a portable extension to specify
+ * metadata that overrides the annotations that exist on a
+ * bean class. The portable extension is responsible for
+ * implementing the interfaces, thereby exposing the metadata
+ * to the container. The container must use the operations of
+ * <tt>Annotated</tt> and its subinterfaces to discover program
+ * element types and annotations, instead of directly calling the
+ * Java Reflection API.</p>
+ *
+
+ */
+package javax.enterprise.inject.spi;
\ No newline at end of file
15 years, 1 month
Weld SVN: r4375 - api/trunk/cdi/src/main/java/javax/enterprise/inject/spi.
by weld-commits＠lists.jboss.org
Author: gavin.king(a)jboss.com
Date: 2009-10-28 23:56:24 -0400 (Wed, 28 Oct 2009)
New Revision: 4375
Modified:
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Annotated.java
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedCallable.java
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedConstructor.java
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedField.java
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedMember.java
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedMethod.java
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedParameter.java
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedType.java
Log:
Refresh all Annotated stuff
Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Annotated.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Annotated.java 2009-10-29 03:43:10 UTC (rev 4374)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Annotated.java 2009-10-29 03:56:24 UTC (rev 4375)
@@ -22,7 +22,7 @@
import java.util.Set;
/**
- * <p>Represents an annotated program element.<p>
+ * <p>Represents a Java program element that can be annotated.<p>
*
* <p>A portable extension may provide an alternative metadata
* source, such as configuration by XML. <tt>Annotated</tt>
Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedCallable.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedCallable.java 2009-10-29 03:43:10 UTC (rev 4374)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedCallable.java 2009-10-29 03:56:24 UTC (rev 4375)
@@ -16,24 +16,21 @@
*/
package javax.enterprise.inject.spi;
-import java.lang.reflect.Member;
import java.util.List;
/**
- * The metadata for a callable member which can be parsed by the
- * {@link BeanManager}.
+ * <p>Represents a callable member of a Java type.</p>
*
- * The semantics are similar to {@link Member}
- *
+ * @author Gavin King
* @author Pete Muir
*
- * @param <X> the type of the member
+ * @param <X> the declaring type
*/
public interface AnnotatedCallable<X> extends AnnotatedMember<X>
{
/**
- * Get the parameters of the callable member.
+ * <p>Get the parameters of the callable member.</p>
*
* @return the parameters
*/
Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedConstructor.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedConstructor.java 2009-10-29 03:43:10 UTC (rev 4374)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedConstructor.java 2009-10-29 03:56:24 UTC (rev 4375)
@@ -20,22 +20,21 @@
import java.lang.reflect.Constructor;
/**
- * The metadata for an annotated constructor which can be parsed by the
- * {@link BeanManager}.
+ * <p>Represents a constructor of a Java class.</p>
*
- * The semantics are similar to {@link Constructor}.
- *
+ * @author Gavin King
* @author Pete Muir
*
- * @param <X> the type of declaring class
+ * @param <X> the declaring class
+ * @see Constructor
*/
public interface AnnotatedConstructor<X> extends AnnotatedCallable<X>
{
/**
- * Get the underlying {@link Constructor} instance.
+ * <p>Get the underlying {@link Constructor}.</p>
*
- * @return the constructor instance
+ * @return the constructor
*/
public Constructor<X> getJavaMember();
Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedField.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedField.java 2009-10-29 03:43:10 UTC (rev 4374)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedField.java 2009-10-29 03:56:24 UTC (rev 4375)
@@ -17,23 +17,22 @@
package javax.enterprise.inject.spi;
import java.lang.reflect.Field;
-import java.lang.reflect.Member;
/**
- * The metadata for an annotated field which can be parsed by the {@link BeanManager}.
+ * <p>Represents a field of a Java class.</p>
*
- * The semantics are similar to {@link Field}.
- *
+ * @author Gavin King
* @author Pete Muir
*
- * @param <X> the type of the field
+ * @param <X> the declaring type
+ * @see Field
*/
public interface AnnotatedField<X> extends AnnotatedMember<X> {
/**
- * Get the underlying {@link Member} instance.
+ * <p>Get the underlying {@link Field}.</p>
*
- * @return the member instance
+ * @return the {@link Field}
*/
public Field getJavaMember();
Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedMember.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedMember.java 2009-10-29 03:43:10 UTC (rev 4374)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedMember.java 2009-10-29 03:56:24 UTC (rev 4375)
@@ -20,32 +20,35 @@
import java.lang.reflect.Member;
/**
- * The metadata for an annotated member which can be parsed by the
- * {@link BeanManager}. The semantics are similar to {@link Member}.
+ * <p>Represents a member of a Java type.</p>
*
+ * @author Gavin King
* @author Pete Muir
- * @param <X> the type of the declaring type
+ *
+ * @param <X> the declaring type
+ * @see Member
*/
public interface AnnotatedMember<X> extends Annotated
{
/**
- * Get the underlying {@link Member} instance.
+ * <p>Get the underlying {@link Member}.</p>
*
- * @return the {@linkplain Member member}
+ * @return the {@link Member}
*/
public Member getJavaMember();
/**
- * Determines if the member is static.
+ * <p>Determines if the member is static.</p>
*
- * @return true if the member is static
+ * @return <tt>true</tt> if the member is static
*/
public boolean isStatic();
/**
- * Get the {@linkplain AnnotatedType type} which declares this member.
+ * <p>Get the {@linkplain AnnotatedType type} which declares this
+ * member.</p>
*
- * @return the {@linkplain AnnotatedType type} of which declares this member
+ * @return the type which declares this member
*/
public AnnotatedType<X> getDeclaringType();
}
Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedMethod.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedMethod.java 2009-10-29 03:43:10 UTC (rev 4374)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedMethod.java 2009-10-29 03:56:24 UTC (rev 4375)
@@ -19,18 +19,21 @@
import java.lang.reflect.Method;
/**
- * The metadata for an annotated method which can be parsed by the
- * {@link BeanManager}. The semantics are similar to {@link Method}.
+ * <p>Represents a method of a Java type.</p>
*
+ * @author Gavin King
* @author Pete Muir
- * @param <X> the return type of the method
+ *
+ * @param <X> the declaring type
+ * @see Method
*/
public interface AnnotatedMethod<X> extends AnnotatedCallable<X>
{
/**
- * Get the underlying {@link Method} instance. return the {@linkplain Method
- * method}
+ * <p>Get the underlying {@link Method}.</p>
+ *
+ * @return the {@link Method}
*/
public Method getJavaMember();
}
Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedParameter.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedParameter.java 2009-10-29 03:43:10 UTC (rev 4374)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedParameter.java 2009-10-29 03:56:24 UTC (rev 4375)
@@ -18,27 +18,29 @@
package javax.enterprise.inject.spi;
/**
- * The metadata for an annotated parameter which can be parsed by the
- * {@link BeanManager}.
+ * <p>Represents a parameter of a method or constructor.</p>
*
+ * @author Gavin King
* @author Pete Muir
*
- * @param <X> the type of the parameter
+ * @param <X> the type that declares the method or constructor
*/
public interface AnnotatedParameter<X> extends Annotated
{
/**
- * The position of the parameter in the callable's argument list.
+ * <p>Get the position of the parameter in the method or
+ * constructor argument list.</p>
*
* @return the position of the parameter
*/
public int getPosition();
/**
- * The declaring {@linkplain AnnotatedCallable callable}.
+ * <p>Get the declaring {@linkplain AnnotatedCallable method or
+ * constructor}.</p>
*
- * @return the declaring {@linkplain AnnotatedCallable callable}
+ * @return the declaring callable
*/
public AnnotatedCallable<X> getDeclaringCallable();
Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedType.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedType.java 2009-10-29 03:43:10 UTC (rev 4374)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedType.java 2009-10-29 03:56:24 UTC (rev 4375)
@@ -20,41 +20,44 @@
import java.util.Set;
/**
- * The metadata for an annotated type which can be parsed by the
- * {@link BeanManager}. The semantics are similar to {@link Class}.
+ * <p>Represents a Java type.</p>
*
+ * @author Gavin King
* @author Pete Muir
- * @param <X> the type of the class
+ *
+ * @param <X> the type
+ * @see java.lang.Class
*/
public interface AnnotatedType<X> extends Annotated
{
/**
- * Get the underlying {@linkplain java.lang.Class class} instance.
+ * <p>Get the underlying {@link java.lang.Class}.</p>
*
- * @return the {@link java.lang.Class} of the instance
+ * @return the {@link java.lang.Class}
*/
public Class<X> getJavaClass();
/**
- * Get the {@linkplain AnnotatedConstructor constructors} belonging to the class If an empty set is returned, a
- * default (no-args) constructor will be assumed.
+ * <p>Get the {@linkplain AnnotatedConstructor constructors} of the type.
+ * If an empty set is returned, a default constructor with no parameters
+ * will be assumed.</p>
*
- * @return the {@linkplain AnnotatedConstructor constructors}, or an empty set if none are defined
+ * @return the constructors, or an empty set if none are defined
*/
public Set<AnnotatedConstructor<X>> getConstructors();
/**
- * Get the {@linkplain AnnotatedMethod business methods} belonging to the class.
+ * <p>Get the {@linkplain AnnotatedMethod methods} of the type.</p>
*
- * @return the {@linkplain AnnotatedMethod methods}, or an empty set if none are defined
+ * @return the methods, or an empty set if none are defined
*/
public Set<AnnotatedMethod<? super X>> getMethods();
/**
- * Get the {@linkplain AnnotatedField fields} belonging to the class.
+ * <p>Get the {@linkplain AnnotatedField fields} of the type.<p>
*
- * @return the {@linkplain AnnotatedField fields}, or an empty set if none are defined
+ * @return the fields, or an empty set if none are defined
*/
public Set<AnnotatedField<? super X>> getFields();
}
15 years, 1 month
Weld SVN: r4374 - cdi-tck/trunk/impl/src/main/java/org/jboss/jsr299/tck/tests/interceptors/definition.
by weld-commits＠lists.jboss.org
Author: marius.bogoevici
Date: 2009-10-28 23:43:10 -0400 (Wed, 28 Oct 2009)
New Revision: 4374
Modified:
cdi-tck/trunk/impl/src/main/java/org/jboss/jsr299/tck/tests/interceptors/definition/InterceptorDefinitionTest.java
Log:
Enable fixed test
Modified: cdi-tck/trunk/impl/src/main/java/org/jboss/jsr299/tck/tests/interceptors/definition/InterceptorDefinitionTest.java
===================================================================
--- cdi-tck/trunk/impl/src/main/java/org/jboss/jsr299/tck/tests/interceptors/definition/InterceptorDefinitionTest.java 2009-10-29 03:34:11 UTC (rev 4373)
+++ cdi-tck/trunk/impl/src/main/java/org/jboss/jsr299/tck/tests/interceptors/definition/InterceptorDefinitionTest.java 2009-10-29 03:43:10 UTC (rev 4374)
@@ -202,7 +202,7 @@
getCurrentManager().resolveInterceptors(InterceptionType.AROUND_INVOKE, nonBinding);
}
- @Test(groups = "ri-broken")
+ @Test
@SpecAssertions({
@SpecAssertion(section = "7.2", id = "a"),
@SpecAssertion(section = "9.2", id = "a"),
15 years, 1 month
Weld SVN: r4373 - api/trunk/cdi/src/main/java/javax/enterprise/inject/spi.
by weld-commits＠lists.jboss.org
Author: gavin.king(a)jboss.com
Date: 2009-10-28 23:34:11 -0400 (Wed, 28 Oct 2009)
New Revision: 4373
Modified:
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Annotated.java
Log:
doc Annotated
Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Annotated.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Annotated.java 2009-10-29 03:33:05 UTC (rev 4372)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Annotated.java 2009-10-29 03:34:11 UTC (rev 4373)
@@ -35,7 +35,7 @@
* element types and annotations, instead of directly calling the
* Java Reflection API.</p>
*
- * @see java.lang.reflect.AnnotatedElement.
+ * @see java.lang.reflect.AnnotatedElement
*
* @author Gavin King
* @author Pete Muir
15 years, 1 month
Weld SVN: r4372 - api/trunk/cdi/src/main/java/javax/enterprise/inject/spi.
by weld-commits＠lists.jboss.org
Author: gavin.king(a)jboss.com
Date: 2009-10-28 23:33:05 -0400 (Wed, 28 Oct 2009)
New Revision: 4372
Modified:
api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Annotated.java
Log:
doc Annotated
Modified: api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Annotated.java
===================================================================
--- api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Annotated.java 2009-10-29 03:32:40 UTC (rev 4371)
+++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/Annotated.java 2009-10-29 03:33:05 UTC (rev 4372)
@@ -18,17 +18,26 @@
package javax.enterprise.inject.spi;
import java.lang.annotation.Annotation;
-import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Type;
import java.util.Set;
/**
- * The metadata for an annotated element which can be parsed by the
- * {@link BeanManager}.
+ * <p>Represents an annotated program element.<p>
*
- * The semantics are similar to {@link AnnotatedElement}.
+ * <p>A portable extension may provide an alternative metadata
+ * source, such as configuration by XML. <tt>Annotated</tt>
+ * and its subtypes allow a portable extension to specify
+ * metadata that overrides the annotations that exist on a
+ * bean class. The portable extension is responsible for
+ * implementing the interfaces, thereby exposing the metadata
+ * to the container. The container must use the operations of
+ * <tt>Annotated</tt> and its subinterfaces to discover program
+ * element types and annotations, instead of directly calling the
+ * Java Reflection API.</p>
*
+ * @see java.lang.reflect.AnnotatedElement.
*
+ * @author Gavin King
* @author Pete Muir
* @author Clint Popetz
*
@@ -37,43 +46,46 @@
{
/**
- * Get the type of the annotated element
+ * <p>Get the type of the annotated program element.</p>
*
- * @return the type
+ * @return the type of the annotated program element
*/
public Type getBaseType();
/**
- * Get all types the base type should be considered assignable to
+ * <p>Get all types to which the base type should be considered
+ * assignable.</p>
*
- * @return a set of types the base type should be considered assignable to
+ * @return a set of all types to which the base type should be considered
+ * assignable
*/
public Set<Type> getTypeClosure();
/**
- * Get the annotation instance on the annotated element for a given annotation
- * type.
+ * <p>Get program element annotation of a certain annotation type.</p>
*
* @param <T> the type of the annotation
- * @param annotationType the class object of the annotation type
- * @return the annotation instance, or null if no annotation is present for
- * the given annotationType
+ * @param annotationType the class of the annotation type
+ * @return the program element annotation of the given annotation type,
+ * or a null value
*/
public <T extends Annotation> T getAnnotation(Class<T> annotationType);
/**
- * Get all the annotation instances on the annotated element
+ * <p>Get all annotations of the program element.</p>
*
- * @return the annotation instances, or an empty set if no annotations are
- * present
+ * @return all annotations of the program element, or an empty set if no
+ * annotations are present
*/
public Set<Annotation> getAnnotations();
/**
- * Determine if an annotation is present on the annotated element
+ * <p>Determine if the program element has an annotation of a
+ * certain annotation type.<p>
*
* @param annotationType the annotation type to check for
- * @return true if the annotation is present
+ * @return <tt>true</tt> if the program element has an annotation of the
+ * given annotation type, or <tt>false</tt> otherwise
*/
public boolean isAnnotationPresent(Class<? extends Annotation> annotationType);
}
15 years, 1 month