org.springframework.core.type

Class StandardAnnotationMetadata

java.lang.Object

org.springframework.core.type.StandardClassMetadata

org.springframework.core.type.StandardAnnotationMetadata

All Implemented Interfaces:

AnnotatedTypeMetadata, AnnotationMetadata, ClassMetadata

public class StandardAnnotationMetadata
extends StandardClassMetadata
implements AnnotationMetadata

AnnotationMetadata implementation that uses standard reflection to introspect a given Class.

Since:

2.5

Author:

Juergen Hoeller, Mark Fisher, Chris Beams, Phillip Webb, Sam Brannen

Constructor Summary

Constructors

Constructor and Description
StandardAnnotationMetadata(Class<?> introspectedClass) Create a new StandardAnnotationMetadata wrapper for the given Class.
StandardAnnotationMetadata(Class<?> introspectedClass, boolean nestedAnnotationsAsMap) Create a new StandardAnnotationMetadata wrapper for the given Class, providing the option to return any nested annotations or annotation arrays in the form of AnnotationAttributes instead of actual Annotation instances.

Method Summary

Modifier and Type	Method and Description
MultiValueMap<String,Object>	getAllAnnotationAttributes(String annotationName) Retrieve all attributes of all annotations of the given type, if any (i.e.
MultiValueMap<String,Object>	getAllAnnotationAttributes(String annotationName, boolean classValuesAsString) Retrieve all attributes of all annotations of the given type, if any (i.e.
Set<MethodMetadata>	getAnnotatedMethods(String annotationName) Retrieve the method metadata for all methods that are annotated (or meta-annotated) with the given annotation type.
Map<String,Object>	getAnnotationAttributes(String annotationName) Retrieve the attributes of the annotation of the given type, if any (i.e.
Map<String,Object>	getAnnotationAttributes(String annotationName, boolean classValuesAsString) Retrieve the attributes of the annotation of the given type, if any (i.e.
Set<String>	getAnnotationTypes() Get the fully qualified class names of all annotation types that are present on the underlying class.
Set<String>	getMetaAnnotationTypes(String annotationName) Get the fully qualified class names of all meta-annotation types that are present on the given annotation type on the underlying class.
boolean	hasAnnotatedMethods(String annotationName) Determine whether the underlying class has any methods that are annotated (or meta-annotated) with the given annotation type.
boolean	hasAnnotation(String annotationName) Determine whether an annotation of the given type is present on the underlying class.
boolean	hasMetaAnnotation(String annotationName) Determine whether the underlying class has an annotation that is itself annotated with the meta-annotation of the given type.
boolean	isAnnotated(String annotationName) Determine whether the underlying element has an annotation or meta-annotation of the given type defined.

Methods inherited from class org.springframework.core.type.StandardClassMetadata

getClassName, getEnclosingClassName, getInterfaceNames, getIntrospectedClass, getMemberClassNames, getSuperClassName, hasEnclosingClass, hasSuperClass, isAbstract, isAnnotation, isConcrete, isFinal, isIndependent, isInterface

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.core.type.ClassMetadata

getClassName, getEnclosingClassName, getInterfaceNames, getMemberClassNames, getSuperClassName, hasEnclosingClass, hasSuperClass, isAbstract, isAnnotation, isConcrete, isFinal, isIndependent, isInterface

Constructor Detail

StandardAnnotationMetadata

public StandardAnnotationMetadata(Class<?> introspectedClass)

Create a new StandardAnnotationMetadata wrapper for the given Class.

Parameters:

introspectedClass - the Class to introspect

See Also:

StandardAnnotationMetadata(Class, boolean)

StandardAnnotationMetadata

public StandardAnnotationMetadata(Class<?> introspectedClass,
                                  boolean nestedAnnotationsAsMap)

Create a new StandardAnnotationMetadata wrapper for the given Class, providing the option to return any nested annotations or annotation arrays in the form of AnnotationAttributes instead of actual Annotation instances.

Parameters:

introspectedClass - the Class to introspect

nestedAnnotationsAsMap - return nested annotations and annotation arrays as AnnotationAttributes for compatibility with ASM-based AnnotationMetadata implementations

Since:

3.1.1

Method Detail

getAnnotationTypes

public Set<String> getAnnotationTypes()

Description copied from interface: AnnotationMetadata

Get the fully qualified class names of all annotation types that are present on the underlying class.

Specified by:

getAnnotationTypes in interface AnnotationMetadata

Returns:

the annotation type names

getMetaAnnotationTypes

public Set<String> getMetaAnnotationTypes(String annotationName)

Description copied from interface: AnnotationMetadata

Get the fully qualified class names of all meta-annotation types that are present on the given annotation type on the underlying class.

Specified by:

getMetaAnnotationTypes in interface AnnotationMetadata

Parameters:

annotationName - the fully qualified class name of the meta-annotation type to look for

Returns:

the meta-annotation type names, or an empty set if none found

hasAnnotation

public boolean hasAnnotation(String annotationName)

Description copied from interface: AnnotationMetadata

Determine whether an annotation of the given type is present on the underlying class.

Specified by:

hasAnnotation in interface AnnotationMetadata

Parameters:

annotationName - the fully qualified class name of the annotation type to look for

Returns:

true if a matching annotation is present

hasMetaAnnotation

public boolean hasMetaAnnotation(String annotationName)

Description copied from interface: AnnotationMetadata

Determine whether the underlying class has an annotation that is itself annotated with the meta-annotation of the given type.

Specified by:

hasMetaAnnotation in interface AnnotationMetadata

Parameters:

annotationName - the fully qualified class name of the meta-annotation type to look for

Returns:

true if a matching meta-annotation is present

isAnnotated

public boolean isAnnotated(String annotationName)

Description copied from interface: AnnotatedTypeMetadata

Determine whether the underlying element has an annotation or meta-annotation of the given type defined.

If this method returns true, then AnnotatedTypeMetadata.getAnnotationAttributes(java.lang.String) will return a non-null Map.

Specified by:

isAnnotated in interface AnnotatedTypeMetadata

Parameters:

annotationName - the fully qualified class name of the annotation type to look for

Returns:

whether a matching annotation is defined

getAnnotationAttributes

public Map<String,Object> getAnnotationAttributes(String annotationName)

Description copied from interface: AnnotatedTypeMetadata

Retrieve the attributes of the annotation of the given type, if any (i.e. if defined on the underlying element, as direct annotation or meta-annotation), also taking attribute overrides on composed annotations into account.

Specified by:

getAnnotationAttributes in interface AnnotatedTypeMetadata

Parameters:

annotationName - the fully qualified class name of the annotation type to look for

Returns:

a Map of attributes, with the attribute name as key (e.g. "value") and the defined attribute value as Map value. This return value will be null if no matching annotation is defined.

getAnnotationAttributes

@Nullable
public Map<String,Object> getAnnotationAttributes(String annotationName,
                                                            boolean classValuesAsString)

Description copied from interface: AnnotatedTypeMetadata

Retrieve the attributes of the annotation of the given type, if any (i.e. if defined on the underlying element, as direct annotation or meta-annotation), also taking attribute overrides on composed annotations into account.

Specified by:

getAnnotationAttributes in interface AnnotatedTypeMetadata

Parameters:

annotationName - the fully qualified class name of the annotation type to look for

classValuesAsString - whether to convert class references to String class names for exposure as values in the returned Map, instead of Class references which might potentially have to be loaded first

Returns:

a Map of attributes, with the attribute name as key (e.g. "value") and the defined attribute value as Map value. This return value will be null if no matching annotation is defined.

getAllAnnotationAttributes

@Nullable
public MultiValueMap<String,Object> getAllAnnotationAttributes(String annotationName)

Description copied from interface: AnnotatedTypeMetadata

Retrieve all attributes of all annotations of the given type, if any (i.e. if defined on the underlying element, as direct annotation or meta-annotation). Note that this variant does not take attribute overrides into account.

Specified by:

getAllAnnotationAttributes in interface AnnotatedTypeMetadata

Parameters:

annotationName - the fully qualified class name of the annotation type to look for

Returns:

a MultiMap of attributes, with the attribute name as key (e.g. "value") and a list of the defined attribute values as Map value. This return value will be null if no matching annotation is defined.

See Also:

AnnotatedTypeMetadata.getAllAnnotationAttributes(String, boolean)

getAllAnnotationAttributes

@Nullable
public MultiValueMap<String,Object> getAllAnnotationAttributes(String annotationName,
                                                                         boolean classValuesAsString)

Description copied from interface: AnnotatedTypeMetadata

Retrieve all attributes of all annotations of the given type, if any (i.e. if defined on the underlying element, as direct annotation or meta-annotation). Note that this variant does not take attribute overrides into account.

Specified by:

getAllAnnotationAttributes in interface AnnotatedTypeMetadata

Parameters:

annotationName - the fully qualified class name of the annotation type to look for

classValuesAsString - whether to convert class references to String

Returns:

a MultiMap of attributes, with the attribute name as key (e.g. "value") and a list of the defined attribute values as Map value. This return value will be null if no matching annotation is defined.

See Also:

AnnotatedTypeMetadata.getAllAnnotationAttributes(String)

hasAnnotatedMethods

public boolean hasAnnotatedMethods(String annotationName)

Description copied from interface: AnnotationMetadata

Determine whether the underlying class has any methods that are annotated (or meta-annotated) with the given annotation type.

Specified by:

hasAnnotatedMethods in interface AnnotationMetadata

Parameters:

annotationName - the fully qualified class name of the annotation type to look for

getAnnotatedMethods

public Set<MethodMetadata> getAnnotatedMethods(String annotationName)

Description copied from interface: AnnotationMetadata

Retrieve the method metadata for all methods that are annotated (or meta-annotated) with the given annotation type.

For any returned method, AnnotatedTypeMetadata.isAnnotated(java.lang.String) will return true for the given annotation type.

Specified by:

getAnnotatedMethods in interface AnnotationMetadata

Parameters:

annotationName - the fully qualified class name of the annotation type to look for

Returns:

a set of MethodMetadata for methods that have a matching annotation. The return value will be an empty set if no methods match the annotation type.