org.springframework.core.type

Interface AnnotatedTypeMetadata

All Known Subinterfaces:

AnnotationMetadata, MethodMetadata

All Known Implementing Classes:

AnnotationMetadataReadingVisitor, MethodMetadataReadingVisitor, StandardAnnotationMetadata, StandardMethodMetadata

public interface AnnotatedTypeMetadata

Defines access to the annotations of a specific type (class or method), in a form that does not necessarily require the class-loading.

Since:

4.0

Author:

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

See Also:

AnnotationMetadata, MethodMetadata

Method Summary

Modifier and Type	Method and Description
MultiValueMap<java.lang.String,java.lang.Object>	getAllAnnotationAttributes(java.lang.String annotationType) 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 annotationType, boolean classValuesAsString) Retrieve all attributes of all annotations of the given type, if any (i.e.
java.util.Map<java.lang.String,java.lang.Object>	getAnnotationAttributes(java.lang.String annotationType) Retrieve the attributes of the annotation of the given type, if any (i.e.
java.util.Map<java.lang.String,java.lang.Object>	getAnnotationAttributes(java.lang.String annotationType, boolean classValuesAsString) Retrieve the attributes of the annotation of the given type, if any (i.e.
boolean	isAnnotated(java.lang.String annotationType) Determine whether the underlying type has an annotation or meta-annotation of the given type defined.

Method Detail

isAnnotated

boolean isAnnotated(java.lang.String annotationType)

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

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

Parameters:

annotationType - the annotation type to look for

Returns:

whether a matching annotation is defined

getAnnotationAttributes

java.util.Map<java.lang.String,java.lang.Object> getAnnotationAttributes(java.lang.String annotationType)

Retrieve the attributes of the annotation of the given type, if any (i.e. if defined on the underlying class, as direct annotation or as meta-annotation).

Parameters:

annotationType - 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

java.util.Map<java.lang.String,java.lang.Object> getAnnotationAttributes(java.lang.String annotationType,
                                                                         boolean classValuesAsString)

Retrieve the attributes of the annotation of the given type, if any (i.e. if defined on the underlying class, as direct annotation or as meta-annotation).

Parameters:

annotationType - 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

MultiValueMap<java.lang.String,java.lang.Object> getAllAnnotationAttributes(java.lang.String annotationType)

Retrieve all attributes of all annotations of the given type, if any (i.e. if defined on the underlying type (class or method), as direct annotation or as meta-annotation).

Parameters:

annotationType - 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:

getAllAnnotationAttributes(String, boolean)

getAllAnnotationAttributes

MultiValueMap<java.lang.String,java.lang.Object> getAllAnnotationAttributes(java.lang.String annotationType,
                                                                            boolean classValuesAsString)

Retrieve all attributes of all annotations of the given type, if any (i.e. if defined on the underlying type (class or method), as direct annotation or as meta-annotation).

Parameters:

annotationType - 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:

getAllAnnotationAttributes(String)