org.springframework.core.annotation

Class AnnotationAttributes

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<java.lang.String,java.lang.Object>

org.springframework.core.annotation.AnnotationAttributes

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class AnnotationAttributes
extends java.util.LinkedHashMap<java.lang.String,java.lang.Object>

LinkedHashMap subclass representing annotation attribute key-value pairs as read by AnnotationUtils, AnnotatedElementUtils, and Spring's reflection- and ASM-based AnnotationMetadata implementations.

Provides 'pseudo-reification' to avoid noisy Map generics in the calling code as well as convenience methods for looking up annotation attributes in a type-safe fashion, including support for attribute aliases configured via @AliasFor.

Since:

3.1.1

Author:

Chris Beams, Sam Brannen, Juergen Hoeller

See Also:

AnnotationUtils.getAnnotationAttributes(java.lang.annotation.Annotation), AnnotatedElementUtils, AliasFor, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Class<? extends java.lang.annotation.Annotation>	annotationType
private java.lang.String	displayName

Constructor Summary

Constructors

Constructor and Description
AnnotationAttributes() Create a new, empty AnnotationAttributes instance.
AnnotationAttributes(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Create a new, empty AnnotationAttributes instance for the specified annotationType.
AnnotationAttributes(int initialCapacity) Create a new, empty AnnotationAttributes instance with the given initial capacity to optimize performance.
AnnotationAttributes(java.util.Map<java.lang.String,java.lang.Object> map) Create a new AnnotationAttributes instance, wrapping the provided map and all its key-value pairs.

Method Summary

Modifier and Type	Method and Description
java.lang.Class<? extends java.lang.annotation.Annotation>	annotationType() Get the type of annotation represented by this AnnotationAttributes instance.
private void	assertAttributePresence(java.lang.String attributeName, java.lang.Object attributeValue)
private void	assertAttributePresence(java.lang.String attributeName, java.lang.String aliasName, java.lang.Object attributeValue)
private void	assertAttributeType(java.lang.String attributeName, java.lang.Object attributeValue, java.lang.Class<?> expectedType)
private void	assertNotException(java.lang.String attributeName, java.lang.Object attributeValue)
static AnnotationAttributes	fromMap(java.util.Map<java.lang.String,java.lang.Object> map) Return an AnnotationAttributes instance based on the given map.
java.lang.Class<?>[]	getAliasedClassArray(java.lang.String attributeName, java.lang.Class<? extends java.lang.annotation.Annotation> annotationType, java.lang.Object annotationSource) Get the value stored under the specified attributeName as an array of classes, taking into account alias semantics defined via @AliasFor.
java.lang.String	getAliasedString(java.lang.String attributeName, java.lang.Class<? extends java.lang.annotation.Annotation> annotationType, java.lang.Object annotationSource) Get the value stored under the specified attributeName as a string, taking into account alias semantics defined via @AliasFor.
java.lang.String[]	getAliasedStringArray(java.lang.String attributeName, java.lang.Class<? extends java.lang.annotation.Annotation> annotationType, java.lang.Object annotationSource) Get the value stored under the specified attributeName as an array of strings, taking into account alias semantics defined via @AliasFor.
AnnotationAttributes	getAnnotation(java.lang.String attributeName) Get the AnnotationAttributes stored under the specified attributeName.
<A extends java.lang.annotation.Annotation> A	getAnnotation(java.lang.String attributeName, java.lang.Class<A> annotationType) Get the annotation of type annotationType stored under the specified attributeName.
AnnotationAttributes[]	getAnnotationArray(java.lang.String attributeName) Get the array of AnnotationAttributes stored under the specified attributeName.
<A extends java.lang.annotation.Annotation> A[]	getAnnotationArray(java.lang.String attributeName, java.lang.Class<A> annotationType) Get the array of type annotationType stored under the specified attributeName.
private <T> T	getAttribute(java.lang.String attributeName, java.lang.Class<T> expectedType) Get the value stored under the specified attributeName, ensuring that the value is of the expectedType.
boolean	getBoolean(java.lang.String attributeName) Get the value stored under the specified attributeName as a boolean.
<T> java.lang.Class<? extends T>	getClass(java.lang.String attributeName) Get the value stored under the specified attributeName as a class.
java.lang.Class<?>[]	getClassArray(java.lang.String attributeName) Get the value stored under the specified attributeName as an array of classes.
<E extends java.lang.Enum<?>> E	getEnum(java.lang.String attributeName) Get the value stored under the specified attributeName as an enum.
<N extends java.lang.Number> N	getNumber(java.lang.String attributeName) Get the value stored under the specified attributeName as a number.
private <T> T	getRequiredAttribute(java.lang.String attributeName, java.lang.Class<T> expectedType) Get the value stored under the specified attributeName, ensuring that the value is of the expectedType.
private <T> T	getRequiredAttributeWithAlias(java.lang.String attributeName, java.lang.Class<? extends java.lang.annotation.Annotation> annotationType, java.lang.Object annotationSource, java.lang.Class<T> expectedType) Get the value stored under the specified attributeName as an object of the expectedType, taking into account alias semantics defined via @AliasFor.
java.lang.String	getString(java.lang.String attributeName) Get the value stored under the specified attributeName as a string.
java.lang.String[]	getStringArray(java.lang.String attributeName) Get the value stored under the specified attributeName as an array of strings.
java.lang.Object	putIfAbsent(java.lang.String key, java.lang.Object value) Store the supplied value in this map under the specified key, unless a value is already stored under the key.
java.lang.String	toString()
private java.lang.String	valueToString(java.lang.Object value)

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, remove, remove, replace, replace, size

Field Detail

annotationType

private final java.lang.Class<? extends java.lang.annotation.Annotation> annotationType

displayName

private final java.lang.String displayName

Constructor Detail

AnnotationAttributes

public AnnotationAttributes()

Create a new, empty AnnotationAttributes instance.

AnnotationAttributes

public AnnotationAttributes(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

Create a new, empty AnnotationAttributes instance for the specified annotationType.

Parameters:

annotationType - the type of annotation represented by this AnnotationAttributes instance; never null

Since:

4.2

AnnotationAttributes

public AnnotationAttributes(int initialCapacity)

Create a new, empty AnnotationAttributes instance with the given initial capacity to optimize performance.

Parameters:

initialCapacity - initial size of the underlying map

AnnotationAttributes

public AnnotationAttributes(java.util.Map<java.lang.String,java.lang.Object> map)

Create a new AnnotationAttributes instance, wrapping the provided map and all its key-value pairs.

Parameters:

map - original source of annotation attribute key-value pairs

See Also:

fromMap(Map)

Method Detail

annotationType

public java.lang.Class<? extends java.lang.annotation.Annotation> annotationType()

Get the type of annotation represented by this AnnotationAttributes instance.

Returns:

the annotation type, or null if unknown

Since:

4.2

getString

public java.lang.String getString(java.lang.String attributeName)

Get the value stored under the specified attributeName as a string.

Parameters:

attributeName - the name of the attribute to get; never null or empty

Returns:

the value

Throws:

java.lang.IllegalArgumentException - if the attribute does not exist or if it is not of the expected type

getAliasedString

public java.lang.String getAliasedString(java.lang.String attributeName,
                                         java.lang.Class<? extends java.lang.annotation.Annotation> annotationType,
                                         java.lang.Object annotationSource)

Get the value stored under the specified attributeName as a string, taking into account alias semantics defined via @AliasFor.

If there is no value stored under the specified attributeName but the attribute has an alias declared via @AliasFor, the value of the alias will be returned.

Parameters:

attributeName - the name of the attribute to get; never null or empty

annotationType - the type of annotation represented by this AnnotationAttributes instance; never null

annotationSource - the source of the annotation represented by this AnnotationAttributes (e.g., the AnnotatedElement); or null if unknown

Returns:

the string value

Throws:

java.lang.IllegalArgumentException - if the attribute and its alias do not exist or are not of type String

AnnotationConfigurationException - if the attribute and its alias are both present with different non-empty values

Since:

4.2

See Also:

ObjectUtils.isEmpty(Object)

getStringArray

public java.lang.String[] getStringArray(java.lang.String attributeName)

Get the value stored under the specified attributeName as an array of strings.

If the value stored under the specified attributeName is a string, it will be wrapped in a single-element array before returning it.

Parameters:

attributeName - the name of the attribute to get; never null or empty

Returns:

the value

Throws:

java.lang.IllegalArgumentException - if the attribute does not exist or if it is not of the expected type

getAliasedStringArray

public java.lang.String[] getAliasedStringArray(java.lang.String attributeName,
                                                java.lang.Class<? extends java.lang.annotation.Annotation> annotationType,
                                                java.lang.Object annotationSource)

Get the value stored under the specified attributeName as an array of strings, taking into account alias semantics defined via @AliasFor.

If there is no value stored under the specified attributeName but the attribute has an alias declared via @AliasFor, the value of the alias will be returned.

Parameters:

attributeName - the name of the attribute to get; never null or empty

annotationType - the type of annotation represented by this AnnotationAttributes instance; never null

annotationSource - the source of the annotation represented by this AnnotationAttributes (e.g., the AnnotatedElement); or null if unknown

Returns:

the array of strings

Throws:

java.lang.IllegalArgumentException - if the attribute and its alias do not exist or are not of type String[]

AnnotationConfigurationException - if the attribute and its alias are both present with different non-empty values

Since:

4.2

getBoolean

public boolean getBoolean(java.lang.String attributeName)

Get the value stored under the specified attributeName as a boolean.

Parameters:

attributeName - the name of the attribute to get; never null or empty

Returns:

the value

Throws:

java.lang.IllegalArgumentException - if the attribute does not exist or if it is not of the expected type

getNumber

public <N extends java.lang.Number> N getNumber(java.lang.String attributeName)

Get the value stored under the specified attributeName as a number.

Parameters:

attributeName - the name of the attribute to get; never null or empty

Returns:

the value

Throws:

java.lang.IllegalArgumentException - if the attribute does not exist or if it is not of the expected type

getEnum

public <E extends java.lang.Enum<?>> E getEnum(java.lang.String attributeName)

Get the value stored under the specified attributeName as an enum.

Parameters:

attributeName - the name of the attribute to get; never null or empty

Returns:

the value

Throws:

java.lang.IllegalArgumentException - if the attribute does not exist or if it is not of the expected type

getClass

public <T> java.lang.Class<? extends T> getClass(java.lang.String attributeName)

Get the value stored under the specified attributeName as a class.

Parameters:

attributeName - the name of the attribute to get; never null or empty

Returns:

the value

Throws:

java.lang.IllegalArgumentException - if the attribute does not exist or if it is not of the expected type

getClassArray

public java.lang.Class<?>[] getClassArray(java.lang.String attributeName)

Get the value stored under the specified attributeName as an array of classes.

If the value stored under the specified attributeName is a class, it will be wrapped in a single-element array before returning it.

Parameters:

attributeName - the name of the attribute to get; never null or empty

Returns:

the value

Throws:

java.lang.IllegalArgumentException - if the attribute does not exist or if it is not of the expected type

getAliasedClassArray

public java.lang.Class<?>[] getAliasedClassArray(java.lang.String attributeName,
                                                 java.lang.Class<? extends java.lang.annotation.Annotation> annotationType,
                                                 java.lang.Object annotationSource)

Get the value stored under the specified attributeName as an array of classes, taking into account alias semantics defined via @AliasFor.

If there is no value stored under the specified attributeName but the attribute has an alias declared via @AliasFor, the value of the alias will be returned.

Parameters:

attributeName - the name of the attribute to get; never null or empty

annotationType - the type of annotation represented by this AnnotationAttributes instance; never null

annotationSource - the source of the annotation represented by this AnnotationAttributes (e.g., the AnnotatedElement); or null if unknown

Returns:

the array of classes

Throws:

java.lang.IllegalArgumentException - if the attribute and its alias do not exist or are not of type Class[]

AnnotationConfigurationException - if the attribute and its alias are both present with different non-empty values

Since:

4.2

getAnnotation

public AnnotationAttributes getAnnotation(java.lang.String attributeName)

Get the AnnotationAttributes stored under the specified attributeName.

Note: if you expect an actual annotation, invoke getAnnotation(String, Class) instead.

Parameters:

attributeName - the name of the attribute to get; never null or empty

Returns:

the AnnotationAttributes

Throws:

java.lang.IllegalArgumentException - if the attribute does not exist or if it is not of the expected type

getAnnotation

public <A extends java.lang.annotation.Annotation> A getAnnotation(java.lang.String attributeName,
                                                                   java.lang.Class<A> annotationType)

Get the annotation of type annotationType stored under the specified attributeName.

Parameters:

attributeName - the name of the attribute to get; never null or empty

annotationType - the expected annotation type; never null

Returns:

the annotation

Throws:

java.lang.IllegalArgumentException - if the attribute does not exist or if it is not of the expected type

Since:

4.2

getAnnotationArray

public AnnotationAttributes[] getAnnotationArray(java.lang.String attributeName)

Get the array of AnnotationAttributes stored under the specified attributeName.

If the value stored under the specified attributeName is an instance of AnnotationAttributes, it will be wrapped in a single-element array before returning it.

Note: if you expect an actual array of annotations, invoke getAnnotationArray(String, Class) instead.

Parameters:

attributeName - the name of the attribute to get; never null or empty

Returns:

the array of AnnotationAttributes

Throws:

java.lang.IllegalArgumentException - if the attribute does not exist or if it is not of the expected type

getAnnotationArray

public <A extends java.lang.annotation.Annotation> A[] getAnnotationArray(java.lang.String attributeName,
                                                                          java.lang.Class<A> annotationType)

Get the array of type annotationType stored under the specified attributeName.

If the value stored under the specified attributeName is an Annotation, it will be wrapped in a single-element array before returning it.

Parameters:

attributeName - the name of the attribute to get; never null or empty

annotationType - the expected annotation type; never null

Returns:

the annotation array

Throws:

java.lang.IllegalArgumentException - if the attribute does not exist or if it is not of the expected type

Since:

4.2

getRequiredAttribute

private <T> T getRequiredAttribute(java.lang.String attributeName,
                                   java.lang.Class<T> expectedType)

Get the value stored under the specified attributeName, ensuring that the value is of the expectedType.

If the expectedType is an array and the value stored under the specified attributeName is a single element of the component type of the expected array type, the single element will be wrapped in a single-element array of the appropriate type before returning it.

Parameters:

attributeName - the name of the attribute to get; never null or empty

expectedType - the expected type; never null

Returns:

the value

Throws:

java.lang.IllegalArgumentException - if the attribute does not exist or if it is not of the expected type

getRequiredAttributeWithAlias

private <T> T getRequiredAttributeWithAlias(java.lang.String attributeName,
                                            java.lang.Class<? extends java.lang.annotation.Annotation> annotationType,
                                            java.lang.Object annotationSource,
                                            java.lang.Class<T> expectedType)

Get the value stored under the specified attributeName as an object of the expectedType, taking into account alias semantics defined via @AliasFor.

If there is no value stored under the specified attributeName but the attribute has an alias declared via @AliasFor, the value of the alias will be returned.

Parameters:

attributeName - the name of the attribute to get; never null or empty

annotationType - the type of annotation represented by this AnnotationAttributes instance; never null

annotationSource - the source of the annotation represented by this AnnotationAttributes (e.g., the AnnotatedElement); or null if unknown

expectedType - the expected type; never null

Returns:

the value

Throws:

java.lang.IllegalArgumentException - if the attribute and its alias do not exist or are not of the expectedType

AnnotationConfigurationException - if the attribute and its alias are both present with different non-empty values

Since:

4.2

See Also:

ObjectUtils.isEmpty(Object)

getAttribute

private <T> T getAttribute(java.lang.String attributeName,
                           java.lang.Class<T> expectedType)

Get the value stored under the specified attributeName, ensuring that the value is of the expectedType.

Parameters:

attributeName - the name of the attribute to get; never null or empty

expectedType - the expected type; never null

Returns:

the value

Throws:

java.lang.IllegalArgumentException - if the attribute is not of the expected type

See Also:

getRequiredAttribute(String, Class)

assertAttributePresence

private void assertAttributePresence(java.lang.String attributeName,
                                     java.lang.Object attributeValue)

assertAttributePresence

private void assertAttributePresence(java.lang.String attributeName,
                                     java.lang.String aliasName,
                                     java.lang.Object attributeValue)

assertNotException

private void assertNotException(java.lang.String attributeName,
                                java.lang.Object attributeValue)

assertAttributeType

private void assertAttributeType(java.lang.String attributeName,
                                 java.lang.Object attributeValue,
                                 java.lang.Class<?> expectedType)

putIfAbsent

public java.lang.Object putIfAbsent(java.lang.String key,
                                    java.lang.Object value)

Store the supplied value in this map under the specified key, unless a value is already stored under the key.

Specified by:

putIfAbsent in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

putIfAbsent in class java.util.HashMap<java.lang.String,java.lang.Object>

Parameters:

key - the key under which to store the value

value - the value to store

Returns:

the current value stored in this map, or null if no value was previously stored in this map

Since:

4.2

See Also:

LinkedHashMap.get(java.lang.Object), HashMap.put(K, V)

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractMap<java.lang.String,java.lang.Object>

valueToString

private java.lang.String valueToString(java.lang.Object value)

fromMap

public static AnnotationAttributes fromMap(java.util.Map<java.lang.String,java.lang.Object> map)

Return an AnnotationAttributes instance based on the given map.

If the map is already an AnnotationAttributes instance, it will be cast and returned immediately without creating a new instance. Otherwise a new instance will be created by passing the supplied map to the AnnotationAttributes(Map) constructor.

Parameters:

map - original source of annotation attribute key-value pairs