程序包 cn.taketoday.core.annotation

类 TypeMappedAnnotation<A extends Annotation>

java.lang.Object

cn.taketoday.core.annotation.AbstractMergedAnnotation<A>

cn.taketoday.core.annotation.TypeMappedAnnotation<A>

类型参数:

A - the annotation type

所有已实现的接口:

MergedAnnotation<A>

final class TypeMappedAnnotation<A extends Annotation>
extends AbstractMergedAnnotation<A>

MergedAnnotation that adapts attributes from a root annotation by applying the mapping and mirroring rules of an AnnotationTypeMapping.

Root attribute values are extracted from a source object using a supplied BiFunction. This allows various different annotation models to be supported by the same class. For example, the attributes source might be an actual Annotation instance where methods on the annotation instance are invoked to extract values. Equally, the source could be a simple Map with values extracted using Map.get(Object).

Extracted root attribute values must be compatible with the attribute return type, namely:

Return Type	Extracted Type
Class	Class or String
Class[]	Class[] or String[]
Annotation	Annotation, Map, or Object compatible with the value extractor
Annotation[]	Annotation[], Map[], or Object[] where elements are compatible with the value extractor
Other types	An exact match or the appropriate primitive wrapper

从以下版本开始:

4.0

作者:

Phillip Webb, Juergen Hoeller, Sam Brannen

另请参阅:

• TypeMappedAnnotations

嵌套类概要

从接口继承的嵌套类/接口 cn.taketoday.core.annotation.MergedAnnotation

MergedAnnotation.Adapt

字段概要

字段

修饰符和类型	字段	说明
private final int	aggregateIndex
private final Predicate<String>	attributeFilter
private final ClassLoader	classLoader
private static final Map<Class<?>,Object>	EMPTY_ARRAYS
private final AnnotationTypeMapping	mapping
private final int[]	resolvedMirrors
private final int[]	resolvedRootMirrors
private final Object	rootAttributes
private final Object	source
private final boolean	useMergedValues
private final ValueExtractor	valueExtractor

从接口继承的字段 cn.taketoday.core.annotation.MergedAnnotation

VALUE

构造器概要

构造器

限定符	构造器	说明
private	TypeMappedAnnotation(AnnotationTypeMapping mapping, ClassLoader classLoader, Object source, Object rootAttributes, ValueExtractor valueExtractor, int aggregateIndex)
private	TypeMappedAnnotation(AnnotationTypeMapping mapping, ClassLoader classLoader, Object source, Object rootAnnotation, ValueExtractor valueExtractor, int aggregateIndex, boolean useMergedValues, Predicate<String> attributeFilter, int[] resolvedRootMirrors, int[] resolvedMirrors)
private	TypeMappedAnnotation(AnnotationTypeMapping mapping, ClassLoader classLoader, Object source, Object rootAttributes, ValueExtractor valueExtractor, int aggregateIndex, int[] resolvedRootMirrors)

方法概要

修饰符和类型	方法	说明
private <T> T	adapt(Method attribute, Object value, Class<T> type)
private Object	adaptForAttribute(Method attribute, Object value)
private MergedAnnotation<?>	adaptToMergedAnnotation(Object value, Class<? extends Annotation> annotationType)
private <T extends Map<String, Object>> Object	adaptValueForMapOptions(Method attribute, Object value, Class<?> mapType, Function<MergedAnnotation<?>,T> factory, MergedAnnotation.Adapt[] adaptations)
Map<String,Object>	asMap(MergedAnnotation.Adapt... adaptations)	Get an immutable Map that contains all the annotation attributes.
<T extends Map<String, Object>> T	asMap(Function<MergedAnnotation<?>,T> factory, MergedAnnotation.Adapt... adaptations)	Create a new Map instance of the given type that contains all the annotation attributes.
(专用程序包) static <A extends Annotation> TypeMappedAnnotation<A>	createIfPossible(AnnotationTypeMapping mapping, MergedAnnotation<?> annotation, IntrospectionFailureLogger logger)
(专用程序包) static <A extends Annotation> TypeMappedAnnotation<A>	createIfPossible(AnnotationTypeMapping mapping, Object source, Annotation annotation, int aggregateIndex, IntrospectionFailureLogger logger)
private static <A extends Annotation> TypeMappedAnnotation<A>	createIfPossible(AnnotationTypeMapping mapping, Object source, Object rootAttribute, ValueExtractor valueExtractor, int aggregateIndex, IntrospectionFailureLogger logger)
protected A	createSynthesizedAnnotation()	Factory method used to create the synthesized annotation.
private Object	emptyArray(Class<?> componentType)
(专用程序包) static Object	extractFromMap(Method attribute, Object map)
MergedAnnotation<A>	filterAttributes(Predicate<String> predicate)	Create a new view of the annotation with only attributes that match the given predicate.
(专用程序包) static <A extends Annotation> TypeMappedAnnotation<A>	from(Object source, A annotation)	Create a new MergedAnnotation instance from the specified annotation.
private <T> Class<T>	getAdaptType(Method attribute, Class<T> type)
int	getAggregateIndex()	Get the index of the aggregate collection containing this annotation.
<T extends Annotation> MergedAnnotation<T>	getAnnotation(String attributeName, Class<T> type)	Get a required annotation attribute value from the annotation.
<T extends Annotation> MergedAnnotation<T>[]	getAnnotationArray(String attributeName, Class<T> type)	Get a required annotation array attribute value from the annotation.
private int	getAttributeIndex(String attributeName, boolean required)
protected <T> T	getAttributeValue(String attributeName, Class<T> type)	Get the underlying attribute value.
private ClassLoader	getClassLoader()
<T> Optional<T>	getDefaultValue(String attributeName, Class<T> type)	Get the default attribute value from the annotation as specified in the annotation declaration.
int	getDistance()	Get the distance of this annotation related to its use as a meta-annotation.
MergedAnnotation<?>	getMetaSource()	Get the source of the meta-annotation, or null if the annotation is not meta-present.
List<Class<? extends Annotation>>	getMetaTypes()	Get the complete list of annotation types within the annotation hierarchy from this annotation to the root.
private Object	getRequiredValue(int attributeIndex, String attributeName)
MergedAnnotation<?>	getRoot()	Get the root annotation, i.e. the distance 0 annotation as directly declared on the source.
Object	getSource()	Get the source that ultimately declared the root annotation, or null if the source is not known.
Class<A>	getType()	Get the Class reference for the actual annotation type.
private Class<?>	getTypeForMapOptions(Method attribute, MergedAnnotation.Adapt[] adaptations)
private Object	getValue(int attributeIndex, boolean useConventionMapping, boolean forMirrorResolution)
private <T> T	getValue(int attributeIndex, Class<T> type)
private ValueExtractor	getValueExtractor(Object value)
private Object	getValueForMirrorResolution(Method attribute, Object annotation)
private Object	getValueFromMetaAnnotation(int attributeIndex, boolean forMirrorResolution)
boolean	hasDefaultValue(String attributeName)	Determine if the specified attribute name has a default value when compared to the annotation declaration.
private boolean	isEmptyObjectArray(Object value)
private boolean	isFiltered(String attributeName)
private boolean	isNotSynthesizable(Annotation annotation)	Determine if the supplied annotation has not already been synthesized and whether the mapped annotation is a composed annotation that needs to have its attributes merged or the mapped annotation is synthesizable in general.
boolean	isPresent()	Determine if the annotation is present on the source.
boolean	isSynthesizable()	Determine if this merged annotation is synthesizable.
(专用程序包) static <A extends Annotation> MergedAnnotation<A>	of(ClassLoader classLoader, Object source, Class<A> annotationType, Map<String,?> attributes)
MergedAnnotation<A>	withNonMergedAttributes()	Create a new view of the annotation that exposes non-merged attribute values.

从类继承的方法 cn.taketoday.core.annotation.AbstractMergedAnnotation

asAnnotationAttributes, filterDefaultValues, getBoolean, getBooleanArray, getByte, getByteArray, getChar, getCharArray, getClass, getClassArray, getDefaultValue, getDouble, getDoubleArray, getEnum, getEnumArray, getFloat, getFloatArray, getInt, getIntArray, getLong, getLongArray, getShort, getShortArray, getString, getStringArray, getValue, getValue, hasNonDefaultValue, isDirectlyPresent, isMetaPresent, synthesize, synthesize

从类继承的方法 java.lang.Object

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

从接口继承的方法 cn.taketoday.core.annotation.MergedAnnotation

getBooleanValue, getClassValue, getClassValueArray, getDoubleValue, getIntValue, getLongValue, getStringValue, getStringValueArray, getValue

字段详细资料

EMPTY_ARRAYS

private static final Map<Class<?>,Object> EMPTY_ARRAYS

mapping

private final AnnotationTypeMapping mapping

classLoader

@Nullable
private final ClassLoader classLoader

source

@Nullable
private final Object source

rootAttributes

@Nullable
private final Object rootAttributes

valueExtractor

private final ValueExtractor valueExtractor

aggregateIndex

private final int aggregateIndex

useMergedValues

private final boolean useMergedValues

attributeFilter

@Nullable
private final Predicate<String> attributeFilter

resolvedRootMirrors

private final int[] resolvedRootMirrors

resolvedMirrors

private final int[] resolvedMirrors

构造器详细资料

TypeMappedAnnotation

private TypeMappedAnnotation(AnnotationTypeMapping mapping,
 @Nullable
 ClassLoader classLoader,
 @Nullable
 Object source,
 @Nullable
 Object rootAttributes,
 ValueExtractor valueExtractor,
 int aggregateIndex)

TypeMappedAnnotation

private TypeMappedAnnotation(AnnotationTypeMapping mapping,
 @Nullable
 ClassLoader classLoader,
 @Nullable
 Object source,
 @Nullable
 Object rootAttributes,
 ValueExtractor valueExtractor,
 int aggregateIndex,
 @Nullable
 int[] resolvedRootMirrors)

TypeMappedAnnotation

private TypeMappedAnnotation(AnnotationTypeMapping mapping,
 @Nullable
 ClassLoader classLoader,
 @Nullable
 Object source,
 @Nullable
 Object rootAnnotation,
 ValueExtractor valueExtractor,
 int aggregateIndex,
 boolean useMergedValues,
 @Nullable
 Predicate<String> attributeFilter,
 int[] resolvedRootMirrors,
 int[] resolvedMirrors)

方法详细资料

getType

public Class<A> getType()

从接口复制的说明: MergedAnnotation

Get the Class reference for the actual annotation type.

返回:

the annotation type

getMetaTypes

public List<Class<? extends Annotation>> getMetaTypes()

从接口复制的说明: MergedAnnotation

Get the complete list of annotation types within the annotation hierarchy from this annotation to the root.

Provides a useful way to uniquely identify a merged annotation instance.

返回:

the meta types for the annotation

另请参阅:

• MergedAnnotationPredicates.unique(Function)
• MergedAnnotation.getRoot()
• MergedAnnotation.getMetaSource()

isPresent

public boolean isPresent()

从接口复制的说明: MergedAnnotation

Determine if the annotation is present on the source. Considers directly present and meta-present annotations within the context of the MergedAnnotations.SearchStrategy used.

返回:

true if the annotation is present

getDistance

public int getDistance()

从接口复制的说明: MergedAnnotation

Get the distance of this annotation related to its use as a meta-annotation.

A directly declared annotation has a distance of 0, a meta-annotation has a distance of 1, a meta-annotation on a meta-annotation has a distance of 2, etc. A missing annotation will always return a distance of -1.

返回:

the annotation distance or -1 if the annotation is missing

getAggregateIndex

public int getAggregateIndex()

从接口复制的说明: MergedAnnotation

Get the index of the aggregate collection containing this annotation.

Can be used to reorder a stream of annotations, for example, to give a higher priority to annotations declared on a superclass or interface. A missing annotation will always return an aggregate index of -1.

返回:

the aggregate index (starting at 0) or -1 if the annotation is missing

getSource

@Nullable
public Object getSource()

从接口复制的说明: MergedAnnotation

Get the source that ultimately declared the root annotation, or null if the source is not known.

If this merged annotation was created from an AnnotatedElement then this source will be an element of the same type. If the annotation was loaded without using reflection, the source can be of any type, but should have a sensible toString(). Meta-annotations will always return the same source as the root.

返回:

the source, or null

getMetaSource

@Nullable
public MergedAnnotation<?> getMetaSource()

从接口复制的说明: MergedAnnotation

Get the source of the meta-annotation, or null if the annotation is not meta-present.

The meta-source is the annotation that was meta-annotated with this annotation.

返回:

the meta-annotation source or null

另请参阅:

• MergedAnnotation.getRoot()

getRoot

public MergedAnnotation<?> getRoot()

从接口复制的说明: MergedAnnotation

Get the root annotation, i.e. the distance 0 annotation as directly declared on the source.

返回:

the root annotation

另请参阅:

• MergedAnnotation.getMetaSource()

hasDefaultValue

public boolean hasDefaultValue(String attributeName)

从接口复制的说明: MergedAnnotation

Determine if the specified attribute name has a default value when compared to the annotation declaration.

参数:

attributeName - the attribute name

返回:

true if the attribute value is the same as the default value

getAnnotation

public <T extends Annotation> MergedAnnotation<T> getAnnotation(String attributeName,
 Class<T> type)
                                                         throws NoSuchElementException

从接口复制的说明: MergedAnnotation

Get a required annotation attribute value from the annotation.

参数:

attributeName - the attribute name

type - the annotation type

返回:

the value as a MergedAnnotation

抛出:

NoSuchElementException - if there is no matching attribute

getAnnotationArray

public <T extends Annotation> MergedAnnotation<T>[] getAnnotationArray(String attributeName,
 Class<T> type)
                                                                throws NoSuchElementException

从接口复制的说明: MergedAnnotation

Get a required annotation array attribute value from the annotation.

参数:

attributeName - the attribute name

type - the annotation type

返回:

the value as a MergedAnnotation array

抛出:

NoSuchElementException - if there is no matching attribute

getDefaultValue

public <T> Optional<T> getDefaultValue(String attributeName,
 Class<T> type)

从接口复制的说明: MergedAnnotation

Get the default attribute value from the annotation as specified in the annotation declaration.

参数:

attributeName - the attribute name

type - the attribute type. Must be compatible with the underlying attribute type or Object.class.

返回:

an optional of the default value or Optional.empty() if there is no matching attribute or no defined default

filterAttributes

public MergedAnnotation<A> filterAttributes(Predicate<String> predicate)

从接口复制的说明: MergedAnnotation

Create a new view of the annotation with only attributes that match the given predicate.

参数:

predicate - a predicate used to filter attribute names

返回:

a filtered view of the annotation

另请参阅:

• MergedAnnotation.filterDefaultValues()
• MergedAnnotationPredicates

withNonMergedAttributes

public MergedAnnotation<A> withNonMergedAttributes()

从接口复制的说明: MergedAnnotation

Create a new view of the annotation that exposes non-merged attribute values.

Methods from this view will return attribute values with only alias mirroring rules applied. Aliases to meta-source attributes will not be applied.

返回:

a non-merged view of the annotation

asMap

public Map<String,Object> asMap(MergedAnnotation.Adapt... adaptations)

从接口复制的说明: MergedAnnotation

Get an immutable Map that contains all the annotation attributes.

The adaptations may be used to change the way that values are added.

参数:

adaptations - the adaptations that should be applied to the annotation values

返回:

an immutable map containing the attributes and values

asMap

public <T extends Map<String,
Object>> T asMap(Function<MergedAnnotation<?>,T> factory,
 MergedAnnotation.Adapt... adaptations)

从接口复制的说明: MergedAnnotation

Create a new Map instance of the given type that contains all the annotation attributes.

The adaptations may be used to change the way that values are added.

参数:

factory - a map factory

adaptations - the adaptations that should be applied to the annotation values

返回:

a map containing the attributes and values

getTypeForMapOptions

private Class<?> getTypeForMapOptions(Method attribute,
 MergedAnnotation.Adapt[] adaptations)

adaptValueForMapOptions

private <T extends Map<String,
Object>> Object adaptValueForMapOptions(Method attribute,
 Object value,
 Class<?> mapType,
 Function<MergedAnnotation<?>,T> factory,
 MergedAnnotation.Adapt[] adaptations)

isSynthesizable

public boolean isSynthesizable()

从接口复制的说明: MergedAnnotation

Determine if this merged annotation is synthesizable.

Consult the documentation for MergedAnnotation.synthesize() for an explanation of what is considered synthesizable.

返回:

true if the mapped annotation is synthesizable

createSynthesizedAnnotation

protected A createSynthesizedAnnotation()

从类复制的说明: AbstractMergedAnnotation

Factory method used to create the synthesized annotation.

If the source is an annotation that is not synthesizable, it will be returned unmodified.

Consult the documentation for MergedAnnotation.synthesize() for an explanation of what is considered synthesizable.

指定者:

createSynthesizedAnnotation 在类中 AbstractMergedAnnotation<A extends Annotation>

isNotSynthesizable

private boolean isNotSynthesizable(Annotation annotation)

Determine if the supplied annotation has not already been synthesized and whether the mapped annotation is a composed annotation that needs to have its attributes merged or the mapped annotation is synthesizable in general.

参数:

annotation - the annotation to check

getAttributeValue

@Nullable
protected <T> T getAttributeValue(String attributeName,
 Class<T> type)

从类复制的说明: AbstractMergedAnnotation

Get the underlying attribute value.

指定者:

getAttributeValue 在类中 AbstractMergedAnnotation<A extends Annotation>

参数:

attributeName - the attribute name

type - the type to return (see MergedAnnotation class documentation for details)

返回:

the attribute value or null if the value is not found and is not required

getRequiredValue

private Object getRequiredValue(int attributeIndex,
 String attributeName)

getValue

@Nullable
private <T> T getValue(int attributeIndex,
 Class<T> type)

getValue

@Nullable
private Object getValue(int attributeIndex,
 boolean useConventionMapping,
 boolean forMirrorResolution)

getValueFromMetaAnnotation

@Nullable
private Object getValueFromMetaAnnotation(int attributeIndex,
 boolean forMirrorResolution)

getValueForMirrorResolution

@Nullable
private Object getValueForMirrorResolution(Method attribute,
 Object annotation)

adapt

@Nullable
private <T> T adapt(Method attribute,
 @Nullable
 Object value,
 Class<T> type)

adaptForAttribute

private Object adaptForAttribute(Method attribute,
 Object value)

isEmptyObjectArray

private boolean isEmptyObjectArray(Object value)

emptyArray

private Object emptyArray(Class<?> componentType)

adaptToMergedAnnotation

private MergedAnnotation<?> adaptToMergedAnnotation(Object value,
 Class<? extends Annotation> annotationType)

getValueExtractor

private ValueExtractor getValueExtractor(Object value)

getAdaptType

private <T> Class<T> getAdaptType(Method attribute,
 Class<T> type)

getAttributeIndex

private int getAttributeIndex(String attributeName,
 boolean required)

isFiltered

private boolean isFiltered(String attributeName)

getClassLoader

@Nullable
private ClassLoader getClassLoader()

from

static <A extends Annotation>
TypeMappedAnnotation<A> from(@Nullable
 Object source,
 A annotation)

从接口复制的说明: MergedAnnotation

Create a new MergedAnnotation instance from the specified annotation.

参数:

source - the source for the annotation. This source is used only for information and logging. It does not need to actually contain the specified annotations, and it will not be searched.

annotation - the annotation to include

返回:

a MergedAnnotation instance for the annotation

of

static <A extends Annotation> MergedAnnotation<A> of(@Nullable
 ClassLoader classLoader,
 @Nullable
 Object source,
 Class<A> annotationType,
 @Nullable
 Map<String,?> attributes)

createIfPossible

@Nullable
static <A extends Annotation>
TypeMappedAnnotation<A> createIfPossible(AnnotationTypeMapping mapping,
 MergedAnnotation<?> annotation,
 IntrospectionFailureLogger logger)

createIfPossible

@Nullable
static <A extends Annotation>
TypeMappedAnnotation<A> createIfPossible(AnnotationTypeMapping mapping,
 @Nullable
 Object source,
 Annotation annotation,
 int aggregateIndex,
 IntrospectionFailureLogger logger)

createIfPossible

@Nullable
private static <A extends Annotation>
TypeMappedAnnotation<A> createIfPossible(AnnotationTypeMapping mapping,
 @Nullable
 Object source,
 @Nullable
 Object rootAttribute,
 ValueExtractor valueExtractor,
 int aggregateIndex,
 IntrospectionFailureLogger logger)

extractFromMap

@Nullable
static Object extractFromMap(Method attribute,
 @Nullable
 Object map)