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

Author: dallen6 Date: 2009-10-26 19:16:29 -0400 (Mon, 26 Oct 2009) New Revision: 4345 Modified: 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 api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/InjectionTarget.java Log: Additional JavaDocs for SPI package 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-26 22:02:12 UTC (rev 4344) +++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedCallable.java 2009-10-26 23:16:29 UTC (rev 4345) @@ -33,7 +33,7 @@ { /** - * Get the parameters of the callable member + * Get the parameters of the callable member. * * @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-26 22:02:12 UTC (rev 4344) +++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedConstructor.java 2009-10-26 23:16:29 UTC (rev 4345) @@ -23,7 +23,7 @@ * The metadata for an annotated constructor which can be parsed by the * {@link BeanManager}. * - * The semantics are similar to {@link Constructor} + * The semantics are similar to {@link Constructor}. * * @author Pete Muir * @@ -33,7 +33,7 @@ { /** - * Get the underlying {@link Constructor} instance + * Get the underlying {@link Constructor} instance. * * @return the constructor instance */ 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-26 22:02:12 UTC (rev 4344) +++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedField.java 2009-10-26 23:16:29 UTC (rev 4345) @@ -20,9 +20,9 @@ import java.lang.reflect.Member; /** - * The metadata for an annotated field which can be parsed by the {@link BeanManager} + * The metadata for an annotated field which can be parsed by the {@link BeanManager}. * - * The semantics are similar to {@link Field} + * The semantics are similar to {@link Field}. * * @author Pete Muir * @@ -31,7 +31,7 @@ public interface AnnotatedField<X> extends AnnotatedMember<X> { /** - * Get the underlying {@link Member} instance + * Get the underlying {@link Member} instance. * * @return the member instance */ 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-26 22:02:12 UTC (rev 4344) +++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedMember.java 2009-10-26 23:16:29 UTC (rev 4345) @@ -21,32 +21,31 @@ /** * The metadata for an annotated member which can be parsed by the - * {@link BeanManager}. + * {@link BeanManager}. The semantics are similar to {@link Member}. * - * The semantics are similar to {@link Member} - * * @author Pete Muir - * * @param <X> the type of the declaring type */ -public interface AnnotatedMember<X> extends Annotated +public interface AnnotatedMember<X> extends Annotated { /** - * Get the underlying {@link Member} instance + * Get the underlying {@link Member} instance. * - * @return the member + * @return the {@linkplain Member member} */ public Member getJavaMember(); /** - * Determine if the member is static - * @return + * Determines if the member is static. + * + * @return true if the member is static */ public boolean isStatic(); /** - * Get the type which declares this member - * @return the type of which declares this member + * Get the {@linkplain AnnotatedType type} which declares this member. + * + * @return the {@linkplain AnnotatedType type} of 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-26 22:02:12 UTC (rev 4344) +++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedMethod.java 2009-10-26 23:16:29 UTC (rev 4345) @@ -20,21 +20,17 @@ /** * The metadata for an annotated method which can be parsed by the - * {@link BeanManager} + * {@link BeanManager}. The semantics are similar to {@link Method}. * - * The semantics are similar to {@link Method} - * * @author Pete Muir - * * @param <X> the return type of the method */ public interface AnnotatedMethod<X> extends AnnotatedCallable<X> { /** - * Get the underlying {@link Method} instance - * - * return the method + * Get the underlying {@link Method} instance. return the {@linkplain Method + * 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-26 22:02:12 UTC (rev 4344) +++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedParameter.java 2009-10-26 23:16:29 UTC (rev 4345) @@ -19,7 +19,7 @@ /** * The metadata for an annotated parameter which can be parsed by the - * {@link BeanManager} + * {@link BeanManager}. * * @author Pete Muir * @@ -29,16 +29,16 @@ { /** - * The position of the parameter in the callable's argument list + * The position of the parameter in the callable's argument list. * * @return the position of the parameter */ public int getPosition(); /** - * The declaring callable + * The declaring {@linkplain AnnotatedCallable callable}. * - * @return the declaring callable + * @return the declaring {@linkplain AnnotatedCallable 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-26 22:02:12 UTC (rev 4344) +++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/AnnotatedType.java 2009-10-26 23:16:29 UTC (rev 4345) @@ -20,44 +20,41 @@ import java.util.Set; /** - * The metadata for an annotated type which can be parsed by the {@link BeanManager} + * The metadata for an annotated type which can be parsed by the + * {@link BeanManager}. The semantics are similar to {@link Class}. * - * The semantics are similar to {@link Class}. - * * @author Pete Muir - * * @param <X> the type of the class */ -public interface AnnotatedType<X> extends Annotated { +public interface AnnotatedType<X> extends Annotated +{ /** - * Get the underlying class instance + * Get the underlying {@linkplain java.lang.Class class} instance. * * @return */ public Class<X> getJavaClass(); /** - * Get the constructors belonging to the class + * Get the {@linkplain AnnotatedConstructor constructors} belonging to the class If an empty set is returned, a + * default (no-args) constructor will be assumed. * - * If an empty set is returned, a default (no-args) constructor will be - * assumed. - * - * @return the constructors, or an empty set if none are defined + * @return the {@linkplain AnnotatedConstructor constructors}, or an empty set if none are defined */ public Set<AnnotatedConstructor<X>> getConstructors(); /** - * Get the business methods belonging to the class. + * Get the {@linkplain AnnotatedMethod business methods} belonging to the class. * - * @return the methods, or an empty set if none are defined + * @return the {@linkplain AnnotatedMethod methods}, or an empty set if none are defined */ public Set<AnnotatedMethod<? super X>> getMethods(); /** - * Get the fields belonging to the class + * Get the {@linkplain AnnotatedField fields} belonging to the class. * - * @return the fields, or an empty set if none are defined + * @return the {@linkplain AnnotatedField fields}, or an empty set if none are defined */ public Set<AnnotatedField<? super X>> getFields(); } 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 22:02:12 UTC (rev 4344) +++ api/trunk/cdi/src/main/java/javax/enterprise/inject/spi/InjectionTarget.java 2009-10-26 23:16:29 UTC (rev 4345) @@ -16,6 +16,8 @@ */ package javax.enterprise.inject.spi; +import javax.annotation.PostConstruct; +import javax.annotation.PreDestroy; import javax.enterprise.context.spi.CreationalContext; /** @@ -47,23 +49,23 @@ /** * <p> - * Calls the {@code PostConstruct} callback, if it exists, + * Calls the {@link PostConstruct} callback, if it exists, * according to the semantics required by the Java EE platform specification. * </p> - * @see javax.annotation.PostConstruct + * * @param instance The instance on which to invoke the - * {@code PostConstruct} method + * {@link PostConstruct} method */ public void postConstruct(T instance); /** * <p> - * Calls the {@code PreDestroy} callback, if it exists, + * Calls the {@link PreDestroy} callback, if it exists, * according to the semantics required by the Java EE platform specification. * </p> - * @see javax.annotation.PreDestroy + * * @param instance The instance on which to invoke the - * {@code PreDestroy} method + * {@link PreDestroy} method */ public void preDestroy(T instance);