org.springframework.core.annotation

Class AnnotationUtils.AliasDescriptor

java.lang.Object

org.springframework.core.annotation.AnnotationUtils.AliasDescriptor

Enclosing class:

AnnotationUtils

private static class AnnotationUtils.AliasDescriptor
extends java.lang.Object

AliasDescriptor encapsulates the declaration of @AliasFor on a given annotation attribute and includes support for validating the configuration of aliases (both explicit and implicit).

Since:

4.2.1

See Also:

from(java.lang.reflect.Method), getAttributeAliasNames(), getAttributeOverrideName(java.lang.Class<? extends java.lang.annotation.Annotation>)

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Class<? extends java.lang.annotation.Annotation>	aliasedAnnotationType
private java.lang.reflect.Method	aliasedAttribute
private java.lang.String	aliasedAttributeName
private boolean	isAliasPair
private java.lang.Class<? extends java.lang.annotation.Annotation>	sourceAnnotationType
private java.lang.reflect.Method	sourceAttribute
private java.lang.String	sourceAttributeName

Constructor Summary

Constructors

Modifier	Constructor and Description
private	AliasDescriptor(java.lang.reflect.Method sourceAttribute, AliasFor aliasFor)

Method Summary

Modifier and Type	Method and Description
static AnnotationUtils.AliasDescriptor	from(java.lang.reflect.Method attribute) Create an AliasDescriptor from the declaration of @AliasFor on the supplied annotation attribute and validate the configuration of @AliasFor.
private static java.lang.String	getAliasedAttributeName(AliasFor aliasFor, java.lang.reflect.Method attribute) Get the name of the aliased attribute configured via the supplied @AliasFor annotation on the supplied attribute.
java.util.List<java.lang.String>	getAttributeAliasNames()
private AnnotationUtils.AliasDescriptor	getAttributeOverrideDescriptor()
java.lang.String	getAttributeOverrideName(java.lang.Class<? extends java.lang.annotation.Annotation> metaAnnotationType)
private java.util.List<AnnotationUtils.AliasDescriptor>	getOtherDescriptors()
private boolean	isAliasFor(AnnotationUtils.AliasDescriptor otherDescriptor) Determine if this descriptor and the supplied descriptor both effectively represent aliases for the same attribute in the same target annotation, either explicitly or implicitly.
private boolean	isOverrideFor(java.lang.Class<? extends java.lang.annotation.Annotation> metaAnnotationType) Determine if this descriptor represents an explicit override for an attribute in the supplied metaAnnotationType.
java.lang.String	toString()
private void	validate()
private void	validateAgainst(AnnotationUtils.AliasDescriptor otherDescriptor) Validate this descriptor against the supplied descriptor.
private void	validateDefaultValueConfiguration(java.lang.reflect.Method aliasedAttribute)

Methods inherited from class java.lang.Object

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

Field Detail

sourceAttribute

private final java.lang.reflect.Method sourceAttribute

sourceAnnotationType

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

sourceAttributeName

private final java.lang.String sourceAttributeName

aliasedAttribute

private final java.lang.reflect.Method aliasedAttribute

aliasedAnnotationType

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

aliasedAttributeName

private final java.lang.String aliasedAttributeName

isAliasPair

private final boolean isAliasPair

Constructor Detail

AliasDescriptor

private AliasDescriptor(java.lang.reflect.Method sourceAttribute,
                        AliasFor aliasFor)

Method Detail

from

public static AnnotationUtils.AliasDescriptor from(java.lang.reflect.Method attribute)

Create an AliasDescriptor from the declaration of @AliasFor on the supplied annotation attribute and validate the configuration of @AliasFor.

Parameters:

attribute - the annotation attribute that is annotated with @AliasFor

Returns:

an alias descriptor, or null if the attribute is not annotated with @AliasFor

See Also:

validateAgainst(org.springframework.core.annotation.AnnotationUtils.AliasDescriptor)

validate

private void validate()

validateDefaultValueConfiguration

private void validateDefaultValueConfiguration(java.lang.reflect.Method aliasedAttribute)

validateAgainst

private void validateAgainst(AnnotationUtils.AliasDescriptor otherDescriptor)

Validate this descriptor against the supplied descriptor.

This method only validates the configuration of default values for the two descriptors, since other aspects of the descriptors are validated when they are created.

isOverrideFor

private boolean isOverrideFor(java.lang.Class<? extends java.lang.annotation.Annotation> metaAnnotationType)

Determine if this descriptor represents an explicit override for an attribute in the supplied metaAnnotationType.

See Also:

isAliasFor(org.springframework.core.annotation.AnnotationUtils.AliasDescriptor)

isAliasFor

private boolean isAliasFor(AnnotationUtils.AliasDescriptor otherDescriptor)

Determine if this descriptor and the supplied descriptor both effectively represent aliases for the same attribute in the same target annotation, either explicitly or implicitly.

This method searches the attribute override hierarchy, beginning with this descriptor, in order to detect implicit and transitively implicit aliases.

Returns:

true if this descriptor and the supplied descriptor effectively alias the same annotation attribute

See Also:

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

getAttributeAliasNames

public java.util.List<java.lang.String> getAttributeAliasNames()

getOtherDescriptors

private java.util.List<AnnotationUtils.AliasDescriptor> getOtherDescriptors()

getAttributeOverrideName

public java.lang.String getAttributeOverrideName(java.lang.Class<? extends java.lang.annotation.Annotation> metaAnnotationType)

getAttributeOverrideDescriptor

private AnnotationUtils.AliasDescriptor getAttributeOverrideDescriptor()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAliasedAttributeName

private static java.lang.String getAliasedAttributeName(AliasFor aliasFor,
                                                        java.lang.reflect.Method attribute)

Get the name of the aliased attribute configured via the supplied @AliasFor annotation on the supplied attribute.

This method returns the value of either the attribute or value attribute of @AliasFor, ensuring that only one of the attributes has been declared while simultaneously ensuring that at least one of the attributes has been declared.

Parameters:

aliasFor - the @AliasFor annotation from which to retrieve the aliased attribute name

attribute - the attribute that is annotated with @AliasFor, used solely for building an exception message

Returns:

the name of the aliased attribute (never null or empty)

Throws:

AnnotationConfigurationException - if invalid configuration of @AliasFor is detected

Since:

4.2