org.springframework.core.annotation

Class AnnotationAttributes

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,Object>

org.springframework.core.annotation.AnnotationAttributes

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class AnnotationAttributes
extends LinkedHashMap<String,Object>

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

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.

Since:

3.1.1

Author:

Chris Beams, Sam Brannen

See Also:

Serialized Form

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor and Description
AnnotationAttributes() Create a new, empty AnnotationAttributes instance.
AnnotationAttributes(Class<? extends 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(Map<String,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
Class<? extends Annotation>	annotationType() Get the type of annotation represented by this AnnotationAttributes instance.
static AnnotationAttributes	fromMap(Map<String,Object> map) Return an AnnotationAttributes instance based on the given map.
AnnotationAttributes	getAnnotation(String attributeName)
AnnotationAttributes[]	getAnnotationArray(String attributeName)
boolean	getBoolean(String attributeName)
<T> Class<? extends T>	getClass(String attributeName)
Class<?>[]	getClassArray(String attributeName)
<E extends Enum<?>> E	getEnum(String attributeName)
<N extends Number> N	getNumber(String attributeName)
String	getString(String attributeName)
String[]	getStringArray(String attributeName)
Object	putIfAbsent(String key, Object value) Store the supplied value in this map under the specified key, unless a value is already stored under the key.
String	toString()

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

Constructor Detail

AnnotationAttributes

public AnnotationAttributes()

Create a new, empty AnnotationAttributes instance.

AnnotationAttributes

public AnnotationAttributes(Class<? extends Annotation> annotationType)

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

Parameters:

annotationType - the type of annotation represented by this AnnotationAttributes instance

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(Map<String,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 to wrap

See Also:

fromMap(Map)

Method Detail

annotationType

public Class<? extends 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 String getString(String attributeName)

getStringArray

public String[] getStringArray(String attributeName)

getBoolean

public boolean getBoolean(String attributeName)

getNumber

public <N extends Number> N getNumber(String attributeName)

getEnum

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

getClass

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

getClassArray

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

getAnnotation

public AnnotationAttributes getAnnotation(String attributeName)

getAnnotationArray

public AnnotationAttributes[] getAnnotationArray(String attributeName)

putIfAbsent

public Object putIfAbsent(String key,
                          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 Map<String,Object>

Overrides:

putIfAbsent in class HashMap<String,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

See Also:

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

toString

public String toString()

Overrides:

toString in class AbstractMap<String,Object>

fromMap

public static AnnotationAttributes fromMap(Map<String,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