org.springframework.core.annotation

Class TypeMappedAnnotations

java.lang.Object

org.springframework.core.annotation.TypeMappedAnnotations

All Implemented Interfaces:

java.lang.Iterable<MergedAnnotation<java.lang.annotation.Annotation>>, MergedAnnotations

final class TypeMappedAnnotations
extends java.lang.Object
implements MergedAnnotations

MergedAnnotations implementation that searches for and adapts annotations and meta-annotations using AnnotationTypeMappings.

Since:

5.2

Author:

Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	TypeMappedAnnotations.Aggregate
private class	TypeMappedAnnotations.AggregatesCollector AnnotationsProcessor that collects TypeMappedAnnotations.Aggregate instances.
private class	TypeMappedAnnotations.AggregatesSpliterator<A extends java.lang.annotation.Annotation> Spliterator used to consume merged annotations from the aggregates in depth fist order.
private static class	TypeMappedAnnotations.IsPresent AnnotationsProcessor used to detect if an annotation is directly present or meta-present.
private class	TypeMappedAnnotations.MergedAnnotationFinder<A extends java.lang.annotation.Annotation> AnnotationsProcessor that finds a single MergedAnnotation.

Nested classes/interfaces inherited from interface org.springframework.core.annotation.MergedAnnotations

MergedAnnotations.SearchStrategy

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<TypeMappedAnnotations.Aggregate>	aggregates
private AnnotationFilter	annotationFilter
private java.lang.annotation.Annotation[]	annotations
private java.lang.reflect.AnnotatedElement	element
private static AnnotationFilter	FILTER_ALL
private static MergedAnnotations	NONE
private RepeatableContainers	repeatableContainers
private MergedAnnotations.SearchStrategy	searchStrategy
private java.lang.Object	source

Constructor Summary

Constructors

Modifier	Constructor and Description
private	TypeMappedAnnotations(java.lang.reflect.AnnotatedElement element, MergedAnnotations.SearchStrategy searchStrategy, RepeatableContainers repeatableContainers, AnnotationFilter annotationFilter)
private	TypeMappedAnnotations(java.lang.Object source, java.lang.annotation.Annotation[] annotations, RepeatableContainers repeatableContainers, AnnotationFilter annotationFilter)

Method Summary

Modifier and Type	Method and Description
(package private) static MergedAnnotations	from(java.lang.reflect.AnnotatedElement element, MergedAnnotations.SearchStrategy searchStrategy, RepeatableContainers repeatableContainers, AnnotationFilter annotationFilter) Create a new MergedAnnotations instance containing all annotations and meta-annotations from the specified element and, depending on the MergedAnnotations.SearchStrategy, related inherited elements.
(package private) static MergedAnnotations	from(java.lang.Object source, java.lang.annotation.Annotation[] annotations, RepeatableContainers repeatableContainers, AnnotationFilter annotationFilter) Create a new MergedAnnotations instance from the specified annotations.
<A extends java.lang.annotation.Annotation> MergedAnnotation<A>	get(java.lang.Class<A> annotationType) Return the nearest matching annotation or meta-annotation of the specified type, or MergedAnnotation.missing() if none is present.
<A extends java.lang.annotation.Annotation> MergedAnnotation<A>	get(java.lang.Class<A> annotationType, java.util.function.Predicate<? super MergedAnnotation<A>> predicate) Return the nearest matching annotation or meta-annotation of the specified type, or MergedAnnotation.missing() if none is present.
<A extends java.lang.annotation.Annotation> MergedAnnotation<A>	get(java.lang.Class<A> annotationType, java.util.function.Predicate<? super MergedAnnotation<A>> predicate, MergedAnnotationSelector<A> selector) Return a matching annotation or meta-annotation of the specified type, or MergedAnnotation.missing() if none is present.
<A extends java.lang.annotation.Annotation> MergedAnnotation<A>	get(java.lang.String annotationType) Return the nearest matching annotation or meta-annotation of the specified type, or MergedAnnotation.missing() if none is present.
<A extends java.lang.annotation.Annotation> MergedAnnotation<A>	get(java.lang.String annotationType, java.util.function.Predicate<? super MergedAnnotation<A>> predicate) Return the nearest matching annotation or meta-annotation of the specified type, or MergedAnnotation.missing() if none is present.
<A extends java.lang.annotation.Annotation> MergedAnnotation<A>	get(java.lang.String annotationType, java.util.function.Predicate<? super MergedAnnotation<A>> predicate, MergedAnnotationSelector<A> selector) Return a matching annotation or meta-annotation of the specified type, or MergedAnnotation.missing() if none is present.
private java.util.List<TypeMappedAnnotations.Aggregate>	getAggregates()
<A extends java.lang.annotation.Annotation> boolean	isDirectlyPresent(java.lang.Class<A> annotationType) Determine if the specified annotation is directly present.
boolean	isDirectlyPresent(java.lang.String annotationType) Determine if the specified annotation is either directly present or meta-present.
private static boolean	isMappingForType(AnnotationTypeMapping mapping, AnnotationFilter annotationFilter, java.lang.Object requiredType)
<A extends java.lang.annotation.Annotation> boolean	isPresent(java.lang.Class<A> annotationType) Determine if the specified annotation is either directly present or meta-present.
boolean	isPresent(java.lang.String annotationType) Determine if the specified annotation is directly present.
java.util.Iterator<MergedAnnotation<java.lang.annotation.Annotation>>	iterator()
private <C,R> R	scan(C criteria, AnnotationsProcessor<C,R> processor)
java.util.Spliterator<MergedAnnotation<java.lang.annotation.Annotation>>	spliterator()
private <A extends java.lang.annotation.Annotation> java.util.Spliterator<MergedAnnotation<A>>	spliterator(java.lang.Object annotationType)
java.util.stream.Stream<MergedAnnotation<java.lang.annotation.Annotation>>	stream() Stream all annotations and meta-annotations contained in this collection.
<A extends java.lang.annotation.Annotation> java.util.stream.Stream<MergedAnnotation<A>>	stream(java.lang.Class<A> annotationType) Stream all annotations and meta-annotations that match the specified type.
<A extends java.lang.annotation.Annotation> java.util.stream.Stream<MergedAnnotation<A>>	stream(java.lang.String annotationType) Stream all annotations and meta-annotations that match the specified type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.core.annotation.MergedAnnotations

from, from, from, from

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

FILTER_ALL

private static final AnnotationFilter FILTER_ALL

NONE

private static final MergedAnnotations NONE

source

@Nullable
private final java.lang.Object source

element

@Nullable
private final java.lang.reflect.AnnotatedElement element

searchStrategy

@Nullable
private final MergedAnnotations.SearchStrategy searchStrategy

annotations

@Nullable
private final java.lang.annotation.Annotation[] annotations

repeatableContainers

private final RepeatableContainers repeatableContainers

annotationFilter

private final AnnotationFilter annotationFilter

aggregates

@Nullable
private volatile java.util.List<TypeMappedAnnotations.Aggregate> aggregates

Constructor Detail

TypeMappedAnnotations

private TypeMappedAnnotations(java.lang.reflect.AnnotatedElement element,
                              MergedAnnotations.SearchStrategy searchStrategy,
                              RepeatableContainers repeatableContainers,
                              AnnotationFilter annotationFilter)

TypeMappedAnnotations

private TypeMappedAnnotations(@Nullable
                              java.lang.Object source,
                              java.lang.annotation.Annotation[] annotations,
                              RepeatableContainers repeatableContainers,
                              AnnotationFilter annotationFilter)

Method Detail

isPresent

public <A extends java.lang.annotation.Annotation> boolean isPresent(java.lang.Class<A> annotationType)

Description copied from interface: MergedAnnotations

Determine if the specified annotation is either directly present or meta-present.

Equivalent to calling get(annotationType).isPresent().

Specified by:

isPresent in interface MergedAnnotations

Parameters:

annotationType - the annotation type to check

Returns:

true if the annotation is present

isPresent

public boolean isPresent(java.lang.String annotationType)

Description copied from interface: MergedAnnotations

Determine if the specified annotation is directly present.

Equivalent to calling get(annotationType).isDirectlyPresent().

Specified by:

isPresent in interface MergedAnnotations

Parameters:

annotationType - the fully qualified class name of the annotation type to check

Returns:

true if the annotation is present

isDirectlyPresent

public <A extends java.lang.annotation.Annotation> boolean isDirectlyPresent(java.lang.Class<A> annotationType)

Description copied from interface: MergedAnnotations

Determine if the specified annotation is directly present.

Equivalent to calling get(annotationType).isDirectlyPresent().

Specified by:

isDirectlyPresent in interface MergedAnnotations

Parameters:

annotationType - the annotation type to check

Returns:

true if the annotation is present

isDirectlyPresent

public boolean isDirectlyPresent(java.lang.String annotationType)

Description copied from interface: MergedAnnotations

Determine if the specified annotation is either directly present or meta-present.

Equivalent to calling get(annotationType).isPresent().

Specified by:

isDirectlyPresent in interface MergedAnnotations

Parameters:

annotationType - the fully qualified class name of the annotation type to check

Returns:

true if the annotation is present

get

public <A extends java.lang.annotation.Annotation> MergedAnnotation<A> get(java.lang.Class<A> annotationType)

Description copied from interface: MergedAnnotations

Return the nearest matching annotation or meta-annotation of the specified type, or MergedAnnotation.missing() if none is present.

Specified by:

get in interface MergedAnnotations

Parameters:

annotationType - the annotation type to get

Returns:

a MergedAnnotation instance

get

public <A extends java.lang.annotation.Annotation> MergedAnnotation<A> get(java.lang.Class<A> annotationType,
                                                                           @Nullable
                                                                           java.util.function.Predicate<? super MergedAnnotation<A>> predicate)

Description copied from interface: MergedAnnotations

Return the nearest matching annotation or meta-annotation of the specified type, or MergedAnnotation.missing() if none is present.

Specified by:

get in interface MergedAnnotations

Parameters:

annotationType - the annotation type to get

predicate - a predicate that must match, or null if only type matching is required

Returns:

a MergedAnnotation instance

See Also:

MergedAnnotationPredicates

get

public <A extends java.lang.annotation.Annotation> MergedAnnotation<A> get(java.lang.Class<A> annotationType,
                                                                           @Nullable
                                                                           java.util.function.Predicate<? super MergedAnnotation<A>> predicate,
                                                                           @Nullable
                                                                           MergedAnnotationSelector<A> selector)

Description copied from interface: MergedAnnotations

Return a matching annotation or meta-annotation of the specified type, or MergedAnnotation.missing() if none is present.

Specified by:

get in interface MergedAnnotations

Parameters:

annotationType - the annotation type to get

predicate - a predicate that must match, or null if only type matching is required

selector - a selector used to choose the most appropriate annotation within an aggregate, or null to select the nearest

Returns:

a MergedAnnotation instance

See Also:

MergedAnnotationPredicates, MergedAnnotationSelectors

get

public <A extends java.lang.annotation.Annotation> MergedAnnotation<A> get(java.lang.String annotationType)

Description copied from interface: MergedAnnotations

Return the nearest matching annotation or meta-annotation of the specified type, or MergedAnnotation.missing() if none is present.

Specified by:

get in interface MergedAnnotations

Parameters:

annotationType - the fully qualified class name of the annotation type to get

Returns:

a MergedAnnotation instance

get

public <A extends java.lang.annotation.Annotation> MergedAnnotation<A> get(java.lang.String annotationType,
                                                                           @Nullable
                                                                           java.util.function.Predicate<? super MergedAnnotation<A>> predicate)

Description copied from interface: MergedAnnotations

Return the nearest matching annotation or meta-annotation of the specified type, or MergedAnnotation.missing() if none is present.

Specified by:

get in interface MergedAnnotations

Parameters:

annotationType - the fully qualified class name of the annotation type to get

predicate - a predicate that must match, or null if only type matching is required

Returns:

a MergedAnnotation instance

See Also:

MergedAnnotationPredicates

get

public <A extends java.lang.annotation.Annotation> MergedAnnotation<A> get(java.lang.String annotationType,
                                                                           @Nullable
                                                                           java.util.function.Predicate<? super MergedAnnotation<A>> predicate,
                                                                           @Nullable
                                                                           MergedAnnotationSelector<A> selector)

Description copied from interface: MergedAnnotations

Return a matching annotation or meta-annotation of the specified type, or MergedAnnotation.missing() if none is present.

Specified by:

get in interface MergedAnnotations

Parameters:

annotationType - the fully qualified class name of the annotation type to get

predicate - a predicate that must match, or null if only type matching is required

selector - a selector used to choose the most appropriate annotation within an aggregate, or null to select the nearest

Returns:

a MergedAnnotation instance

See Also:

MergedAnnotationPredicates, MergedAnnotationSelectors

stream

public <A extends java.lang.annotation.Annotation> java.util.stream.Stream<MergedAnnotation<A>> stream(java.lang.Class<A> annotationType)

Description copied from interface: MergedAnnotations

Stream all annotations and meta-annotations that match the specified type. The resulting stream follows the same ordering rules as MergedAnnotations.stream().

Specified by:

stream in interface MergedAnnotations

Parameters:

annotationType - the annotation type to match

Returns:

a stream of matching annotations

stream

public <A extends java.lang.annotation.Annotation> java.util.stream.Stream<MergedAnnotation<A>> stream(java.lang.String annotationType)

Description copied from interface: MergedAnnotations

Stream all annotations and meta-annotations that match the specified type. The resulting stream follows the same ordering rules as MergedAnnotations.stream().

Specified by:

stream in interface MergedAnnotations

Parameters:

annotationType - the fully qualified class name of the annotation type to match

Returns:

a stream of matching annotations

stream

public java.util.stream.Stream<MergedAnnotation<java.lang.annotation.Annotation>> stream()

Description copied from interface: MergedAnnotations

Stream all annotations and meta-annotations contained in this collection. The resulting stream is ordered first by the aggregate index and then by the annotation depth (with the closest annotations first). This ordering means that, for most use-cases, the most suitable annotations appear earliest in the stream.

Specified by:

stream in interface MergedAnnotations

Returns:

a stream of annotations

iterator

public java.util.Iterator<MergedAnnotation<java.lang.annotation.Annotation>> iterator()

Specified by:

iterator in interface java.lang.Iterable<MergedAnnotation<java.lang.annotation.Annotation>>

spliterator

public java.util.Spliterator<MergedAnnotation<java.lang.annotation.Annotation>> spliterator()

Specified by:

spliterator in interface java.lang.Iterable<MergedAnnotation<java.lang.annotation.Annotation>>

spliterator

private <A extends java.lang.annotation.Annotation> java.util.Spliterator<MergedAnnotation<A>> spliterator(@Nullable
                                                                                                           java.lang.Object annotationType)

getAggregates

private java.util.List<TypeMappedAnnotations.Aggregate> getAggregates()

scan

@Nullable
private <C,R> R scan(C criteria,
                               AnnotationsProcessor<C,R> processor)

from

static MergedAnnotations from(java.lang.reflect.AnnotatedElement element,
                              MergedAnnotations.SearchStrategy searchStrategy,
                              RepeatableContainers repeatableContainers,
                              AnnotationFilter annotationFilter)

Description copied from interface: MergedAnnotations

Create a new MergedAnnotations instance containing all annotations and meta-annotations from the specified element and, depending on the MergedAnnotations.SearchStrategy, related inherited elements.

Specified by:

from in interface MergedAnnotations

Parameters:

element - the source element

searchStrategy - the search strategy to use

repeatableContainers - the repeatable containers that may be used by the element annotations or the meta-annotations

annotationFilter - an annotation filter used to restrict the annotations considered

Returns:

a MergedAnnotations instance containing the merged element annotations

from

static MergedAnnotations from(@Nullable
                              java.lang.Object source,
                              java.lang.annotation.Annotation[] annotations,
                              RepeatableContainers repeatableContainers,
                              AnnotationFilter annotationFilter)

Description copied from interface: MergedAnnotations

Create a new MergedAnnotations instance from the specified annotations.

Specified by:

from in interface MergedAnnotations

Parameters:

source - the source for the annotations. 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.

annotations - the annotations to include

repeatableContainers - the repeatable containers that may be used by meta-annotations

annotationFilter - an annotation filter used to restrict the annotations considered

Returns:

a MergedAnnotations instance containing the annotations

isMappingForType

private static boolean isMappingForType(AnnotationTypeMapping mapping,
                                        AnnotationFilter annotationFilter,
                                        @Nullable
                                        java.lang.Object requiredType)