com.github.misberner.apcommons.util.annotations

Class AnnotationUtils

java.lang.Object

com.github.misberner.apcommons.util.annotations.AnnotationUtils

public abstract class AnnotationUtils
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
static AnnotationMirror	findAnnotationMirror(Element elem, CharSequence annClassName) Find an annotation mirror of an element, given the annotation's fully qualified class name.
static AnnotationMirror	findAnnotationMirror(Element elem, Class<? extends Annotation> annClass) Find an annotation mirror of an element, given the annotation's Class object.
static AnnotationValue	findAnnotationValue(AnnotationMirror am, CharSequence valueName) Get an element value from an annotation mirror.
static <A extends Annotation> A	getAncestorAnnotation(Element elem, Class<A> annotationType) Checks if the element or one of its ancestors (i.e., reflexive-transitively enclosing elements) is annotated with the given annotation type, and if so, returns the annotation object.
static Map<String,AnnotationValue>	getAnnotationValues(AnnotationMirror am)
static Map<String,AnnotationValue>	getAnnotationValues(Element element, Class<? extends Annotation> annotationClazz)
static <A extends Annotation> A	getEnclosingAnnotation(Element elem, Class<A> annotationType, boolean onlyDirect)
static <A extends Annotation> A	getParentAnnotation(Element elem, Class<A> annotationType) Checks if the direct parent (i.e., enclosing element) of this element is annotated with the given annotation type, and if so, returns the annotation object.
static boolean	isAncestorAnnotated(Element elem, Class<? extends Annotation>... expectedAnnotations)
static boolean	isAnnotated(Element elem, Class<? extends Annotation>... expectedAnnotations)
static boolean	isEnclosingAnnotated(Element elem, boolean onlyDirect, Class<? extends Annotation>... expectedAnnotations)
static boolean	isParentAnnotated(Element elem, Class<? extends Annotation>... expectedAnnotations)

Methods inherited from class java.lang.Object

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

Method Detail

getParentAnnotation

public static <A extends Annotation> A getParentAnnotation(Element elem,
                                           Class<A> annotationType)

Checks if the direct parent (i.e., enclosing element) of this element is annotated with the given annotation type, and if so, returns the annotation object.

This method is safe in the sense that it won't result in a NullPointerException when the specified element does not have a parent, or a null element reference is specified.

Parameters:

elem - the element

annotationType - the annotation type to check for

Returns:

the annotation object, if the specified element has a parent that is annotated with the given annotation type.

getAncestorAnnotation

public static <A extends Annotation> A getAncestorAnnotation(Element elem,
                                             Class<A> annotationType)

Checks if the element or one of its ancestors (i.e., reflexive-transitively enclosing elements) is annotated with the given annotation type, and if so, returns the annotation object.

This method is safe in the sense that it won't result in a NullPointerException when the specified element does not have a parent, or a null element reference is specified.

Parameters:

elem - the element

annotationType - the annotation type to check for

Returns:

the annotation object, if the specified element or one of its ancestors is annotated with the given annotation type.

getEnclosingAnnotation

public static <A extends Annotation> A getEnclosingAnnotation(Element elem,
                                              Class<A> annotationType,
                                              boolean onlyDirect)

isAnnotated

@SafeVarargs
public static boolean isAnnotated(Element elem,
                              Class<? extends Annotation>... expectedAnnotations)

isParentAnnotated

@SafeVarargs
public static boolean isParentAnnotated(Element elem,
                                    Class<? extends Annotation>... expectedAnnotations)

isAncestorAnnotated

@SafeVarargs
public static boolean isAncestorAnnotated(Element elem,
                                      Class<? extends Annotation>... expectedAnnotations)

isEnclosingAnnotated

@SafeVarargs
public static boolean isEnclosingAnnotated(Element elem,
                                       boolean onlyDirect,
                                       Class<? extends Annotation>... expectedAnnotations)

findAnnotationMirror

public static AnnotationMirror findAnnotationMirror(Element elem,
                                    CharSequence annClassName)

Find an annotation mirror of an element, given the annotation's fully qualified class name.

Parameters:

elem - the element

annClassName - the fully qualified class name of the annotation

Returns:

the respective annotation mirror, or null if the element is not annotated with the given annotation.

findAnnotationMirror

public static AnnotationMirror findAnnotationMirror(Element elem,
                                    Class<? extends Annotation> annClass)

Find an annotation mirror of an element, given the annotation's Class object.

Parameters:

elem - the element

annClass - the annotation's Class object

Returns:

the respective annotation mirror, or null if the element is not annotated with the given annotation.

findAnnotationValue

public static AnnotationValue findAnnotationValue(AnnotationMirror am,
                                  CharSequence valueName)

Get an element value from an annotation mirror.

Note: Annotation mirrors usually do not contain default values, only those that were set explicitly.

Parameters:

am - the annotation mirror

valueName - the name of the value

Returns:

the respective annotation value, or null if no such value exists or was explicitly set

getAnnotationValues

public static Map<String,AnnotationValue> getAnnotationValues(AnnotationMirror am)

getAnnotationValues

public static Map<String,AnnotationValue> getAnnotationValues(Element element,
                                              Class<? extends Annotation> annotationClazz)