org.microbean.cdi

Class Annotations

java.lang.Object

org.microbean.cdi.Annotations

public final class Annotations
extends Object

A utility class housing methods that do helpful things with Annotations, Annotateds and AnnotatedElements.

Author:

Laird Nelson

Method Summary

Modifier and Type	Method and Description
static Collection<? extends Annotation>	getAnnotations(Class<?> c, BeanManager beanManager) Returns a Collection of Annotations that are present on the supplied Class, using the BeanManager.createAnnotatedType(Class) method as appropriate.
static Set<Annotation>	getAnnotationsQualifiedWith(Annotated host, Class<? extends Annotation> metaAnnotationType, BeanManager beanManager) Returns a Set of Annotations that are ultimately qualified with an annotation whose annotation type is equal to the supplied metaAnnotationType.
static Set<Annotation>	getAnnotationsQualifiedWith(AnnotatedElement host, Class<? extends Annotation> metaAnnotationType, BeanManager beanManager) Returns a Set of Annotations that are ultimately qualified with an annotation whose annotation type is equal to the supplied metaAnnotationType.
static boolean	isAnnotationQualifiedWith(Annotation annotation, Class<? extends Annotation> qualifierType, BeanManager beanManager) Returns true if the supplied Annotation is ultimately qualified by an annotation with the supplied qualifierType as its annotationType.
static Set<Annotation>	retainAnnotationsQualifiedWith(Collection<? extends Annotation> suppliedAnnotations, Class<? extends Annotation> metaAnnotationType, BeanManager beanManager) Given a Collection of Annotations, returns a subset of them that are found to be ultimately qualified with an annotation whose annotation type is equal to the supplied metaAnnotationType.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAnnotationsQualifiedWith

public static final Set<Annotation> getAnnotationsQualifiedWith(Annotated host,
                                                                Class<? extends Annotation> metaAnnotationType,
                                                                BeanManager beanManager)

Returns a Set of Annotations that are ultimately qualified with an annotation whose annotation type is equal to the supplied metaAnnotationType.

This method never returns null.

Parameters:

host - the Annotated whose annotations will be used as the initial set; must not be null

metaAnnotationType - the qualifier annotation type to look for; must not be null

beanManager - a BeanManager for retrieving the appropriate annotated type when appropriate; may be null

Returns:

a non-null subset of Annotations

Throws:

NullPointerException - if host or metaAnnotationType is null

See Also:

retainAnnotationsQualifiedWith(Collection, Class, BeanManager)

getAnnotationsQualifiedWith

public static final Set<Annotation> getAnnotationsQualifiedWith(AnnotatedElement host,
                                                                Class<? extends Annotation> metaAnnotationType,
                                                                BeanManager beanManager)

Returns a Set of Annotations that are ultimately qualified with an annotation whose annotation type is equal to the supplied metaAnnotationType.

This method never returns null.

Parameters:

host - the AnnotatedElement whose annotations will be used as the initial set; must not be null

metaAnnotationType - the qualifier annotation type to look for; must not be null

beanManager - a BeanManager for retrieving the appropriate annotated type when appropriate; may be null

Returns:

a non-null subset of Annotations

Throws:

NullPointerException - if host or metaAnnotationType is null

See Also:

retainAnnotationsQualifiedWith(Collection, Class, BeanManager)

retainAnnotationsQualifiedWith

public static final Set<Annotation> retainAnnotationsQualifiedWith(Collection<? extends Annotation> suppliedAnnotations,
                                                                   Class<? extends Annotation> metaAnnotationType,
                                                                   BeanManager beanManager)

Given a Collection of Annotations, returns a subset of them that are found to be ultimately qualified with an annotation whose annotation type is equal to the supplied metaAnnotationType.

This method never returns null.

Parameters:

suppliedAnnotations - a Collection of Annotations that will be used as the initial set; may be null

metaAnnotationType - the qualifier annotation type to look for; must not be null

beanManager - a BeanManager for retrieving the appropriate annotated type when appropriate; may be null

Returns:

a non-null subset of Annotations

Throws:

NullPointerException - if metaAnnotationType is null

getAnnotations

public static final Collection<? extends Annotation> getAnnotations(Class<?> c,
                                                                    BeanManager beanManager)

Returns a Collection of Annotations that are present on the supplied Class, using the BeanManager.createAnnotatedType(Class) method as appropriate.

This method never returns null.

Parameters:

c - the Class whose Annotations should be returned; must not be null

beanManager - a BeanManager whose BeanManager.createAnnotatedType(Class) method will be called; may be null in which case AnnotatedElement.getAnnotations() will be called instead

Returns:

a non-null Collection of Annotations

See Also:

BeanManager.createAnnotatedType(Class), AnnotatedElement.getAnnotations()

isAnnotationQualifiedWith

public static final boolean isAnnotationQualifiedWith(Annotation annotation,
                                                      Class<? extends Annotation> qualifierType,
                                                      BeanManager beanManager)

Returns true if the supplied Annotation is ultimately qualified by an annotation with the supplied qualifierType as its annotationType.

Ultimately qualified means that either the qualifier annotation represented by the supplied qualifierType is present on the supplied annotation or one of its Annotations, or present on one of those Annotations, and so on.

Parameters:

annotation - the Annotation to check; must not be null

qualifierType - the Class representing the annotation type to look for; must not be null

beanManager - a BeanManager whose BeanManager.createAnnotatedType(Class) method will be called; may be null

Returns:

true if the supplied Annotation is ultimately qualified by an annotation with the supplied qualifierType as its annotationType; false otherwise

Throws:

NullPointerException - if annotation or qualifierType is null