org.springframework.core.annotation

Class AnnotationsScanner

java.lang.Object

org.springframework.core.annotation.AnnotationsScanner

abstract class AnnotationsScanner
extends java.lang.Object

Scanner to search for relevant annotations in the annotation hierarchy of an AnnotatedElement.

Since:

5.2

Author:

Phillip Webb

See Also:

AnnotationsProcessor

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Map<java.lang.Class<?>,java.lang.reflect.Method[]>	baseTypeMethodsCache
private static java.util.Map<java.lang.reflect.AnnotatedElement,java.lang.annotation.Annotation[]>	declaredAnnotationCache
private static java.lang.annotation.Annotation[]	NO_ANNOTATIONS
private static java.lang.reflect.Method[]	NO_METHODS

Constructor Summary

Constructors

Modifier	Constructor and Description
private	AnnotationsScanner()

Method Summary

Modifier and Type	Method and Description
(package private) static void	clearCache()
private static <C> java.lang.reflect.Method[]	getBaseTypeMethods(C context, java.lang.Class<?> baseType, java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)
(package private) static <A extends java.lang.annotation.Annotation> A	getDeclaredAnnotation(java.lang.reflect.AnnotatedElement source, java.lang.Class<A> annotationType)
(package private) static java.lang.annotation.Annotation[]	getDeclaredAnnotations(java.lang.reflect.AnnotatedElement source, boolean defensive)
private static <C,R> java.lang.annotation.Annotation[]	getDeclaredAnnotations(C context, java.lang.reflect.AnnotatedElement source, java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter, boolean copy)
(package private) static boolean	hasPlainJavaAnnotationsOnly(java.lang.Class<?> type)
(package private) static boolean	hasPlainJavaAnnotationsOnly(java.lang.Object annotatedElement)
private static boolean	hasSameGenericTypeParameters(java.lang.reflect.Method rootMethod, java.lang.reflect.Method candidateMethod, java.lang.Class<?>[] rootParameterTypes)
private static boolean	hasSameParameterTypes(java.lang.reflect.Method rootMethod, java.lang.reflect.Method candidateMethod)
private static <C> boolean	isFiltered(java.lang.Class<?> sourceClass, C context, java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)
private static boolean	isIgnorable(java.lang.Class<?> annotationType)
(package private) static boolean	isKnownEmpty(java.lang.reflect.AnnotatedElement source, MergedAnnotations.SearchStrategy searchStrategy)
private static boolean	isOverride(java.lang.reflect.Method rootMethod, java.lang.reflect.Method candidateMethod)
private static boolean	isWithoutHierarchy(java.lang.reflect.AnnotatedElement source)
private static <C,R> R	process(C context, java.lang.reflect.AnnotatedElement source, MergedAnnotations.SearchStrategy searchStrategy, AnnotationsProcessor<C,R> processor, java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)
private static <C,R> R	processClass(C context, java.lang.Class<?> source, MergedAnnotations.SearchStrategy searchStrategy, AnnotationsProcessor<C,R> processor, java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)
private static <C,R> R	processClassHierarchy(C context, int[] aggregateIndex, java.lang.Class<?> source, AnnotationsProcessor<C,R> processor, java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter, boolean includeInterfaces)
private static <C,R> R	processClassInheritedAnnotations(C context, java.lang.Class<?> source, AnnotationsProcessor<C,R> processor, java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)
private static <C,R> R	processElement(C context, java.lang.reflect.AnnotatedElement source, AnnotationsProcessor<C,R> processor, java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)
private static <C,R> R	processMethod(C context, java.lang.reflect.Method source, MergedAnnotations.SearchStrategy searchStrategy, AnnotationsProcessor<C,R> processor, java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)
private static <C,R> R	processMethodAnnotations(C context, int aggregateIndex, java.lang.reflect.Method source, AnnotationsProcessor<C,R> processor, java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)
private static <C,R> R	processMethodHierarchy(C context, int[] aggregateIndex, java.lang.Class<?> sourceClass, AnnotationsProcessor<C,R> processor, java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter, java.lang.reflect.Method rootMethod, boolean includeInterfaces)
private static <C,R> R	processMethodInheritedAnnotations(C context, java.lang.reflect.Method source, AnnotationsProcessor<C,R> processor, java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)
(package private) static <C,R> R	scan(C context, java.lang.reflect.AnnotatedElement source, MergedAnnotations.SearchStrategy searchStrategy, AnnotationsProcessor<C,R> processor) Scan the hierarchy of the specified element for relevant annotations and call the processor as required.
(package private) static <C,R> R	scan(C context, java.lang.reflect.AnnotatedElement source, MergedAnnotations.SearchStrategy searchStrategy, AnnotationsProcessor<C,R> processor, java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter) Scan the hierarchy of the specified element for relevant annotations and call the processor as required.

Methods inherited from class java.lang.Object

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

Field Detail

NO_ANNOTATIONS

private static final java.lang.annotation.Annotation[] NO_ANNOTATIONS

NO_METHODS

private static final java.lang.reflect.Method[] NO_METHODS

declaredAnnotationCache

private static final java.util.Map<java.lang.reflect.AnnotatedElement,java.lang.annotation.Annotation[]> declaredAnnotationCache

baseTypeMethodsCache

private static final java.util.Map<java.lang.Class<?>,java.lang.reflect.Method[]> baseTypeMethodsCache

Constructor Detail

AnnotationsScanner

private AnnotationsScanner()

Method Detail

scan

@Nullable
static <C,R> R scan(C context,
                              java.lang.reflect.AnnotatedElement source,
                              MergedAnnotations.SearchStrategy searchStrategy,
                              AnnotationsProcessor<C,R> processor)

Scan the hierarchy of the specified element for relevant annotations and call the processor as required.

Parameters:

context - an optional context object that will be passed back to the processor

source - the source element to scan

searchStrategy - the search strategy to use

processor - the processor that receives the annotations

Returns:

the result of AnnotationsProcessor.finish(Object)

scan

@Nullable
static <C,R> R scan(C context,
                              java.lang.reflect.AnnotatedElement source,
                              MergedAnnotations.SearchStrategy searchStrategy,
                              AnnotationsProcessor<C,R> processor,
                              @Nullable
                              java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)

Scan the hierarchy of the specified element for relevant annotations and call the processor as required.

Parameters:

context - an optional context object that will be passed back to the processor

source - the source element to scan

searchStrategy - the search strategy to use

processor - the processor that receives the annotations

classFilter - an optional filter that can be used to entirely filter out a specific class from the hierarchy

Returns:

the result of AnnotationsProcessor.finish(Object)

process

@Nullable
private static <C,R> R process(C context,
                                         java.lang.reflect.AnnotatedElement source,
                                         MergedAnnotations.SearchStrategy searchStrategy,
                                         AnnotationsProcessor<C,R> processor,
                                         @Nullable
                                         java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)

processClass

@Nullable
private static <C,R> R processClass(C context,
                                              java.lang.Class<?> source,
                                              MergedAnnotations.SearchStrategy searchStrategy,
                                              AnnotationsProcessor<C,R> processor,
                                              @Nullable
                                              java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)

processClassInheritedAnnotations

@Nullable
private static <C,R> R processClassInheritedAnnotations(C context,
                                                                  java.lang.Class<?> source,
                                                                  AnnotationsProcessor<C,R> processor,
                                                                  @Nullable
                                                                  java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)

processClassHierarchy

@Nullable
private static <C,R> R processClassHierarchy(C context,
                                                       int[] aggregateIndex,
                                                       java.lang.Class<?> source,
                                                       AnnotationsProcessor<C,R> processor,
                                                       @Nullable
                                                       java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter,
                                                       boolean includeInterfaces)

processMethod

@Nullable
private static <C,R> R processMethod(C context,
                                               java.lang.reflect.Method source,
                                               MergedAnnotations.SearchStrategy searchStrategy,
                                               AnnotationsProcessor<C,R> processor,
                                               @Nullable
                                               java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)

processMethodInheritedAnnotations

@Nullable
private static <C,R> R processMethodInheritedAnnotations(C context,
                                                                   java.lang.reflect.Method source,
                                                                   AnnotationsProcessor<C,R> processor,
                                                                   @Nullable
                                                                   java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)

processMethodHierarchy

@Nullable
private static <C,R> R processMethodHierarchy(C context,
                                                        int[] aggregateIndex,
                                                        java.lang.Class<?> sourceClass,
                                                        AnnotationsProcessor<C,R> processor,
                                                        @Nullable
                                                        java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter,
                                                        java.lang.reflect.Method rootMethod,
                                                        boolean includeInterfaces)

getBaseTypeMethods

private static <C> java.lang.reflect.Method[] getBaseTypeMethods(C context,
                                                                 java.lang.Class<?> baseType,
                                                                 @Nullable
                                                                 java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)

isOverride

private static boolean isOverride(java.lang.reflect.Method rootMethod,
                                  java.lang.reflect.Method candidateMethod)

hasSameParameterTypes

private static boolean hasSameParameterTypes(java.lang.reflect.Method rootMethod,
                                             java.lang.reflect.Method candidateMethod)

hasSameGenericTypeParameters

private static boolean hasSameGenericTypeParameters(java.lang.reflect.Method rootMethod,
                                                    java.lang.reflect.Method candidateMethod,
                                                    java.lang.Class<?>[] rootParameterTypes)

processMethodAnnotations

@Nullable
private static <C,R> R processMethodAnnotations(C context,
                                                          int aggregateIndex,
                                                          java.lang.reflect.Method source,
                                                          AnnotationsProcessor<C,R> processor,
                                                          @Nullable
                                                          java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)

processElement

@Nullable
private static <C,R> R processElement(C context,
                                                java.lang.reflect.AnnotatedElement source,
                                                AnnotationsProcessor<C,R> processor,
                                                @Nullable
                                                java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)

getDeclaredAnnotations

private static <C,R> java.lang.annotation.Annotation[] getDeclaredAnnotations(C context,
                                                                              java.lang.reflect.AnnotatedElement source,
                                                                              @Nullable
                                                                              java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter,
                                                                              boolean copy)

getDeclaredAnnotation

@Nullable
static <A extends java.lang.annotation.Annotation> A getDeclaredAnnotation(java.lang.reflect.AnnotatedElement source,
                                                                                     java.lang.Class<A> annotationType)

getDeclaredAnnotations

static java.lang.annotation.Annotation[] getDeclaredAnnotations(java.lang.reflect.AnnotatedElement source,
                                                                boolean defensive)

isFiltered

private static <C> boolean isFiltered(java.lang.Class<?> sourceClass,
                                      C context,
                                      @Nullable
                                      java.util.function.BiPredicate<C,java.lang.Class<?>> classFilter)

isIgnorable

private static boolean isIgnorable(java.lang.Class<?> annotationType)

isKnownEmpty

static boolean isKnownEmpty(java.lang.reflect.AnnotatedElement source,
                            MergedAnnotations.SearchStrategy searchStrategy)

hasPlainJavaAnnotationsOnly

static boolean hasPlainJavaAnnotationsOnly(@Nullable
                                           java.lang.Object annotatedElement)

hasPlainJavaAnnotationsOnly

static boolean hasPlainJavaAnnotationsOnly(java.lang.Class<?> type)

isWithoutHierarchy

private static boolean isWithoutHierarchy(java.lang.reflect.AnnotatedElement source)

clearCache

static void clearCache()