org.axonframework.common.annotation

Class AnnotationUtils

java.lang.Object

org.axonframework.common.annotation.AnnotationUtils

public abstract class AnnotationUtils
extends Object

Utility class for locating annotations and attribute values on elements.

Since:

3.0

Author:

Allard Buijze

Method Summary

Modifier and Type	Method and Description
static <T extends Annotation> T	findAnnotation(AnnotatedElement element, Class<T> annotationType) Deprecated. This method does not consider overrides of attributes using meta-annotations. Use findAnnotationAttributes(AnnotatedElement, Class) instead.
static Annotation	findAnnotation(AnnotatedElement element, String annotationType) Deprecated. This method does not consider overrides of attributes using meta-annotations. Use findAnnotationAttributes(AnnotatedElement, String) instead.
static Optional<Map<String,Object>>	findAnnotationAttributes(AnnotatedElement element, Class<? extends Annotation> annotationType) Find the attributes of an annotation of type annotationType on the given element.
static Optional<Map<String,Object>>	findAnnotationAttributes(AnnotatedElement element, String annotationName) Find the attributes of an annotation with given annotationName on the given element.
static boolean	isAnnotationPresent(AnnotatedElement element, Class<? extends Annotation> annotationType) Indicates whether an annotation of given annotationType is present on the given element, considering that the given annotationType may be present as a meta annotation on any other annotation on that element.
static boolean	isAnnotationPresent(AnnotatedElement element, String annotationType) Indicates whether an annotation with given annotationType is present on the given element, considering that the given annotationType may be present as a meta annotation on any other annotation on that element.

Methods inherited from class java.lang.Object

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

Method Detail

findAnnotation

@Deprecated
public static <T extends Annotation> T findAnnotation(AnnotatedElement element,
                                                                   Class<T> annotationType)

Deprecated. This method does not consider overrides of attributes using meta-annotations. Use findAnnotationAttributes(AnnotatedElement, Class) instead.

Find an annotation of given annotationType on the given element, considering that the given annotationType may be present as a meta annotation on any other annotation on that element.

Type Parameters:

T - The generic type of the annotation

Parameters:

element - The element to inspect

annotationType - The type of annotation to find

Returns:

the annotation, or null if no such annotation is present.

findAnnotation

@Deprecated
public static Annotation findAnnotation(AnnotatedElement element,
                                                     String annotationType)

Deprecated. This method does not consider overrides of attributes using meta-annotations. Use findAnnotationAttributes(AnnotatedElement, String) instead.

Find an annotation of given annotationType as String on the given element, considering that the given annotationType may be present as a meta annotation on any other annotation on that element.

Parameters:

element - The element to inspect

annotationType - The type of annotation as String to find

Returns:

the annotation, or null if no such annotation is present.

isAnnotationPresent

public static boolean isAnnotationPresent(AnnotatedElement element,
                                          Class<? extends Annotation> annotationType)

Indicates whether an annotation of given annotationType is present on the given element, considering that the given annotationType may be present as a meta annotation on any other annotation on that element.

Parameters:

element - The element to inspect

annotationType - The type of annotation to find

Returns:

true if such annotation is present.

isAnnotationPresent

public static boolean isAnnotationPresent(AnnotatedElement element,
                                          String annotationType)

Indicates whether an annotation with given annotationType is present on the given element, considering that the given annotationType may be present as a meta annotation on any other annotation on that element.

Parameters:

element - The element to inspect

annotationType - The name of the annotation to find

Returns:

true if such annotation is present.

findAnnotationAttributes

public static Optional<Map<String,Object>> findAnnotationAttributes(AnnotatedElement element,
                                                                    String annotationName)

Find the attributes of an annotation with given annotationName on the given element. The returned optional has a value present if the annotation has been found, either directly on the element, or as a meta-annotation.

The map of attributes contains all the attributes found on the annotation, as well as attributes of any annotations on which the targeted annotation was placed (directly, or indirectly).

Parameters:

element - The element for find the annotation on

annotationName - The name of the annotation to find

Returns:

an optional that resolved to a map with attribute names and value, if the annotation is found

findAnnotationAttributes

public static Optional<Map<String,Object>> findAnnotationAttributes(AnnotatedElement element,
                                                                    Class<? extends Annotation> annotationType)

Find the attributes of an annotation of type annotationType on the given element. The returned optional has a value present if the annotation has been found, either directly on the element, or as a meta-annotation.

The map of attributes contains all the attributes found on the annotation, as well as attributes of any annotations on which the targeted annotation was placed (directly, or indirectly). Note that the value property of annotations is reported as the simple class name (lowercase first character) of the annotation. This allows specific attribute overrides for annotations that have multiple meta-annotation with the value property.

Parameters:

element - The element for find the annotation on

annotationType - The type of the annotation to find

Returns:

an optional that resolved to a map with attribute names and value, if the annotation is found