org.springframework.core.type.classreading

Class AnnotationMetadataReadingVisitor

java.lang.Object

org.springframework.asm.ClassVisitor

org.springframework.core.type.classreading.ClassMetadataReadingVisitor

org.springframework.core.type.classreading.AnnotationMetadataReadingVisitor

All Implemented Interfaces:

AnnotatedTypeMetadata, AnnotationMetadata, ClassMetadata

public class AnnotationMetadataReadingVisitor
extends ClassMetadataReadingVisitor
implements AnnotationMetadata

ASM class visitor which looks for the class name and implemented types as well as for the annotations defined on the class, exposing them through the AnnotationMetadata interface.

Since:

2.5

Author:

Juergen Hoeller, Mark Fisher, Costin Leau, Phillip Webb, Sam Brannen

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<java.lang.String>	annotationSet
protected LinkedMultiValueMap<java.lang.String,AnnotationAttributes>	attributesMap Declared as a LinkedMultiValueMap instead of a MultiValueMap to ensure that the hierarchical ordering of the entries is preserved.
protected java.lang.ClassLoader	classLoader
protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	metaAnnotationMap
protected java.util.Set<MethodMetadata>	methodMetadataSet

Fields inherited from class org.springframework.asm.ClassVisitor

api, cv

Constructor Summary

Constructors

Constructor and Description
AnnotationMetadataReadingVisitor(java.lang.ClassLoader classLoader)

Method Summary

Modifier and Type	Method and Description
MultiValueMap<java.lang.String,java.lang.Object>	getAllAnnotationAttributes(java.lang.String annotationName) Retrieve all attributes of all annotations of the given type, if any (i.e.
MultiValueMap<java.lang.String,java.lang.Object>	getAllAnnotationAttributes(java.lang.String annotationName, boolean classValuesAsString) Retrieve all attributes of all annotations of the given type, if any (i.e.
java.util.Set<MethodMetadata>	getAnnotatedMethods(java.lang.String annotationName) Retrieve the method metadata for all methods that are annotated (or meta-annotated) with the given annotation type.
AnnotationAttributes	getAnnotationAttributes(java.lang.String annotationName) Retrieve the attributes of the annotation of the given type, if any (i.e.
AnnotationAttributes	getAnnotationAttributes(java.lang.String annotationName, boolean classValuesAsString) Retrieve the attributes of the annotation of the given type, if any (i.e.
java.util.Set<java.lang.String>	getAnnotationTypes() Get the fully qualified class names of all annotation types that are present on the underlying class.
java.util.Set<java.lang.String>	getMetaAnnotationTypes(java.lang.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(java.lang.String annotationName) Determine whether the underlying class has any methods that are annotated (or meta-annotated) with the given annotation type.
boolean	hasAnnotation(java.lang.String annotationName) Determine whether an annotation of the given type is present on the underlying class.
boolean	hasMetaAnnotation(java.lang.String metaAnnotationType) Determine whether the underlying class has an annotation that is itself annotated with the meta-annotation of the given type.
boolean	isAnnotated(java.lang.String annotationName) Determine whether the underlying element has an annotation or meta-annotation of the given type defined.
AnnotationVisitor	visitAnnotation(java.lang.String desc, boolean visible) Visits an annotation of the class.
MethodVisitor	visitMethod(int access, java.lang.String name, java.lang.String desc, java.lang.String signature, java.lang.String[] exceptions) Visits a method of the class.

Methods inherited from class org.springframework.core.type.classreading.ClassMetadataReadingVisitor

getClassName, getEnclosingClassName, getInterfaceNames, getMemberClassNames, getSuperClassName, hasEnclosingClass, hasSuperClass, isAbstract, isAnnotation, isConcrete, isFinal, isIndependent, isInterface, visit, visitAttribute, visitEnd, visitField, visitInnerClass, visitOuterClass, visitSource

Methods inherited from class org.springframework.asm.ClassVisitor

visitTypeAnnotation

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

Field Detail

classLoader

protected final java.lang.ClassLoader classLoader

annotationSet

protected final java.util.Set<java.lang.String> annotationSet

metaAnnotationMap

protected final java.util.Map<java.lang.String,java.util.Set<java.lang.String>> metaAnnotationMap

attributesMap

protected final LinkedMultiValueMap<java.lang.String,AnnotationAttributes> attributesMap

Declared as a LinkedMultiValueMap instead of a MultiValueMap to ensure that the hierarchical ordering of the entries is preserved.

See Also:

AnnotationReadingVisitorUtils.getMergedAnnotationAttributes(org.springframework.util.LinkedMultiValueMap<java.lang.String, org.springframework.core.annotation.AnnotationAttributes>, java.util.Map<java.lang.String, java.util.Set<java.lang.String>>, java.lang.String)

methodMetadataSet

protected final java.util.Set<MethodMetadata> methodMetadataSet

Constructor Detail

AnnotationMetadataReadingVisitor

public AnnotationMetadataReadingVisitor(java.lang.ClassLoader classLoader)

Method Detail

visitMethod

public MethodVisitor visitMethod(int access,
                                 java.lang.String name,
                                 java.lang.String desc,
                                 java.lang.String signature,
                                 java.lang.String[] exceptions)

Description copied from class: ClassVisitor

Visits a method of the class. This method must return a new MethodVisitor instance (or null) each time it is called, i.e., it should not return a previously returned visitor.

Overrides:

visitMethod in class ClassMetadataReadingVisitor

Parameters:

access - the method's access flags (see Opcodes). This parameter also indicates if the method is synthetic and/or deprecated.

name - the method's name.

desc - the method's descriptor (see Type).

signature - the method's signature. May be null if the method parameters, return type and exceptions do not use generic types.

exceptions - the internal names of the method's exception classes (see getInternalName). May be null.

Returns:

an object to visit the byte code of the method, or null if this class visitor is not interested in visiting the code of this method.

visitAnnotation

public AnnotationVisitor visitAnnotation(java.lang.String desc,
                                         boolean visible)

Description copied from class: ClassVisitor

Visits an annotation of the class.

Overrides:

visitAnnotation in class ClassMetadataReadingVisitor

Parameters:

desc - the class descriptor of the annotation class.

visible - true if the annotation is visible at runtime.

Returns:

a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.

getAnnotationTypes

public java.util.Set<java.lang.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 java.util.Set<java.lang.String> getMetaAnnotationTypes(java.lang.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

hasAnnotation

public boolean hasAnnotation(java.lang.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(java.lang.String metaAnnotationType)

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:

metaAnnotationType - 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(java.lang.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 AnnotationAttributes getAnnotationAttributes(java.lang.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

public AnnotationAttributes getAnnotationAttributes(java.lang.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

public MultiValueMap<java.lang.String,java.lang.Object> getAllAnnotationAttributes(java.lang.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

public MultiValueMap<java.lang.String,java.lang.Object> getAllAnnotationAttributes(java.lang.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(java.lang.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 java.util.Set<MethodMetadata> getAnnotatedMethods(java.lang.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.