org.springframework.core.annotation

Class AttributeMethods

java.lang.Object

org.springframework.core.annotation.AttributeMethods

final class AttributeMethods
extends java.lang.Object

Provides a quick way to access the attribute methods of an Annotation with consistent ordering as well as a few useful utility methods.

Since:

5.2

Author:

Phillip Webb

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Class<? extends java.lang.annotation.Annotation>	annotationType
private java.lang.reflect.Method[]	attributeMethods
private static java.util.Map<java.lang.Class<? extends java.lang.annotation.Annotation>,AttributeMethods>	cache
private boolean[]	canThrowTypeNotPresentException
private boolean	hasDefaultValueMethod
private boolean	hasNestedAnnotation
private static java.util.Comparator<java.lang.reflect.Method>	methodComparator
(package private) static AttributeMethods	NONE

Constructor Summary

Constructors

Modifier	Constructor and Description
private	AttributeMethods(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType, java.lang.reflect.Method[] attributeMethods)

Method Summary

Modifier and Type	Method and Description
private void	assertAnnotation(java.lang.annotation.Annotation annotation)
(package private) boolean	canThrowTypeNotPresentException(int index) Determine if the attribute at the specified index could throw a TypeNotPresentException when accessed.
private static AttributeMethods	compute(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
(package private) static java.lang.String	describe(java.lang.Class<?> annotationType, java.lang.String attributeName) Create a description for the given attribute method suitable to use in exception messages and logs.
(package private) static java.lang.String	describe(java.lang.reflect.Method attribute) Create a description for the given attribute method suitable to use in exception messages and logs.
(package private) static AttributeMethods	forAnnotationType(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Get the attribute methods for the given annotation type.
(package private) java.lang.reflect.Method	get(int index) Get the attribute at the specified index.
(package private) java.lang.reflect.Method	get(java.lang.String name) Get the attribute with the specified name or null if no matching attribute exists.
(package private) boolean	hasDefaultValueMethod() Determine if at least one of the attribute methods has a default value.
(package private) boolean	hasNestedAnnotation() Determine if at least one of the attribute methods is a nested annotation.
(package private) int	indexOf(java.lang.reflect.Method attribute) Get the index of the specified attribute, or -1 if the attribute is not in this collection.
(package private) int	indexOf(java.lang.String name) Get the index of the attribute with the specified name, or -1 if there is no attribute with the name.
private static boolean	isAttributeMethod(java.lang.reflect.Method method)
(package private) boolean	isOnlyValueAttribute() Determine if this instance only contains only a single attribute named value.
(package private) boolean	isValid(java.lang.annotation.Annotation annotation) Determine if values from the given annotation can be safely accessed without causing any TypeNotPresentExceptions.
(package private) int	size() Get the number of attributes in this collection.
(package private) void	validate(java.lang.annotation.Annotation annotation) Check if values from the given annotation can be safely accessed without causing any TypeNotPresentExceptions.

Methods inherited from class java.lang.Object

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

Field Detail

NONE

static final AttributeMethods NONE

cache

private static final java.util.Map<java.lang.Class<? extends java.lang.annotation.Annotation>,AttributeMethods> cache

methodComparator

private static final java.util.Comparator<java.lang.reflect.Method> methodComparator

annotationType

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

attributeMethods

private final java.lang.reflect.Method[] attributeMethods

canThrowTypeNotPresentException

private final boolean[] canThrowTypeNotPresentException

hasDefaultValueMethod

private final boolean hasDefaultValueMethod

hasNestedAnnotation

private final boolean hasNestedAnnotation

Constructor Detail

AttributeMethods

private AttributeMethods(@Nullable
                         java.lang.Class<? extends java.lang.annotation.Annotation> annotationType,
                         java.lang.reflect.Method[] attributeMethods)

Method Detail

isOnlyValueAttribute

boolean isOnlyValueAttribute()

Determine if this instance only contains only a single attribute named value.

Returns:

true if this is only a value attribute

isValid

boolean isValid(java.lang.annotation.Annotation annotation)

Determine if values from the given annotation can be safely accessed without causing any TypeNotPresentExceptions.

Parameters:

annotation - the annotation to check

Returns:

true if all values are present

See Also:

validate(Annotation)

validate

void validate(java.lang.annotation.Annotation annotation)

Check if values from the given annotation can be safely accessed without causing any TypeNotPresentExceptions. In particular, this method is designed to cover Google App Engine's late arrival of such exceptions for Class values (instead of the more typical early Class.getAnnotations() failure.

Parameters:

annotation - the annotation to validate

Throws:

java.lang.IllegalStateException - if a declared Class attribute could not be read

See Also:

isValid(Annotation)

assertAnnotation

private void assertAnnotation(java.lang.annotation.Annotation annotation)

get

@Nullable
java.lang.reflect.Method get(java.lang.String name)

Get the attribute with the specified name or null if no matching attribute exists.

Parameters:

name - the attribute name to find

Returns:

the attribute method or null

get

java.lang.reflect.Method get(int index)

Get the attribute at the specified index.

Parameters:

index - the index of the attribute to return

Returns:

the attribute method

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

canThrowTypeNotPresentException

boolean canThrowTypeNotPresentException(int index)

Determine if the attribute at the specified index could throw a TypeNotPresentException when accessed.

Parameters:

index - the index of the attribute to check

Returns:

true if the attribute can throw a TypeNotPresentException

indexOf

int indexOf(java.lang.String name)

Get the index of the attribute with the specified name, or -1 if there is no attribute with the name.

Parameters:

name - the name to find

Returns:

the index of the attribute, or -1

indexOf

int indexOf(java.lang.reflect.Method attribute)

Get the index of the specified attribute, or -1 if the attribute is not in this collection.

Parameters:

attribute - the attribute to find

Returns:

the index of the attribute, or -1

size

int size()

Get the number of attributes in this collection.

Returns:

the number of attributes

hasDefaultValueMethod

boolean hasDefaultValueMethod()

Determine if at least one of the attribute methods has a default value.

Returns:

true if there is at least one attribute method with a default value

hasNestedAnnotation

boolean hasNestedAnnotation()

Determine if at least one of the attribute methods is a nested annotation.

Returns:

true if there is at least one attribute method with a nested annotation type

forAnnotationType

static AttributeMethods forAnnotationType(@Nullable
                                          java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

Get the attribute methods for the given annotation type.

Parameters:

annotationType - the annotation type

Returns:

the attribute methods for the annotation type

compute

private static AttributeMethods compute(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

isAttributeMethod

private static boolean isAttributeMethod(java.lang.reflect.Method method)

describe

static java.lang.String describe(@Nullable
                                 java.lang.reflect.Method attribute)

Create a description for the given attribute method suitable to use in exception messages and logs.

Parameters:

attribute - the attribute to describe

Returns:

a description of the attribute

describe

static java.lang.String describe(@Nullable
                                 java.lang.Class<?> annotationType,
                                 @Nullable
                                 java.lang.String attributeName)

Create a description for the given attribute method suitable to use in exception messages and logs.

Parameters:

annotationType - the annotation type

attributeName - the attribute name

Returns:

a description of the attribute