com.blazebit.annotation

Class AnnotationUtils

java.lang.Object

com.blazebit.annotation.AnnotationUtils

public final class AnnotationUtils
extends Object

Utillity class for annotation handling. Basically this class only uses java.lang classes for the methods. The only exception is, that # javax.enterprise.inject.Stereotype is used for annotation 'inheritance'.

Since:

0.1.2

Author:

Christian Beikov

Method Summary

Modifier and Type	Method and Description
static <T extends Annotation> T	findAnnotation(Class<?> clazz, Class<T> annotationClazz) Returns the annotation object for the specified annotation class of the given class object.
static <T extends Annotation> T	findAnnotation(Method m, Class<?> clazz, Class<T> annotationClazz) Returns the annotation object for the specified annotation class of either the method if it can be found, or of the given class object.
static <T extends Annotation> T	findAnnotation(Method m, Class<T> annotationClazz) Returns the annotation object for the specified annotation class of the method if it can be found, otherwise null.
static Set<Annotation>	getAllAnnotations(Class<?> clazz) Returns all annotations of a class, also the annotations of the super classes, implemented interfaces and the annotations that are present in stereotype annotations.
static Set<Annotation>	getAllAnnotations(Method m) Returns all annotations of a class, also the annotations of the super classes, implemented interfaces and the annotations that are present in stereotype annotations.

Methods inherited from class java.lang.Object

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

Method Detail

getAllAnnotations

public static Set<Annotation> getAllAnnotations(Class<?> clazz)

Returns all annotations of a class, also the annotations of the super classes, implemented interfaces and the annotations that are present in stereotype annotations. The stereotype annotation will not be included in the annotation set.

Note that the set can contain annotation objects of the same type with different values for their members.

Parameters:

clazz - the class from which to get the annotations

Returns:

all annotations that are present for the given class

getAllAnnotations

public static Set<Annotation> getAllAnnotations(Method m)

Returns all annotations of a class, also the annotations of the super classes, implemented interfaces and the annotations that are present in stereotype annotations. The stereotype annotation will not be included in the annotation set.

Parameters:

m - the class from which to get the annotations

Returns:

all annotations that are present for the given class

findAnnotation

public static <T extends Annotation> T findAnnotation(Method m,
                                                      Class<?> clazz,
                                                      Class<T> annotationClazz)

Returns the annotation object for the specified annotation class of either the method if it can be found, or of the given class object. First the annotation is searched via the method findAnnotation(java.lang.reflect.Method, java.lang.Class). If the annotation can not be found, the method findAnnotation(java.lang.Class, java.lang.Class) is used to find the annotation on class level.

Type Parameters:

T - The annotation type

Parameters:

m - The method in which to look for the annotation

clazz - The class in which to look for the annotation if it can not be found on method level

annotationClazz - The type of the annotation to look for

Returns:

The annotation with the given type if found, otherwise null

findAnnotation

public static <T extends Annotation> T findAnnotation(Method m,
                                                      Class<T> annotationClazz)

Returns the annotation object for the specified annotation class of the method if it can be found, otherwise null. The annotation is searched in the method which and if a stereotype annotation is found, the annotations present on an annotation are also examined. If the annotation can not be found, null is returned.

Type Parameters:

T - The annotation type

Parameters:

m - The method in which to look for the annotation

annotationClazz - The type of the annotation to look for

Returns:

The annotation with the given type if found, otherwise null

findAnnotation

public static <T extends Annotation> T findAnnotation(Class<?> clazz,
                                                      Class<T> annotationClazz)

Returns the annotation object for the specified annotation class of the given class object. All super types of the given class are examined to find the annotation. If a stereotype annotation is found, the annotations present on an annotation are also examined.

Type Parameters:

T - The annotation type

Parameters:

clazz - The class in which to look for the annotation

annotationClazz - The type of the annotation to look for

Returns:

The annotation with the given type if found, otherwise null