cn.hutool.core.annotation.scanner

Class GenericAnnotationScanner

java.lang.Object

cn.hutool.core.annotation.scanner.GenericAnnotationScanner

All Implemented Interfaces:

AnnotationScanner

public class GenericAnnotationScanner
extends Object
implements AnnotationScanner

通用注解扫描器，支持按不同的层级结构扫描AnnotatedElement上的注解。

当AnnotatedElement类型不同时，“层级结构”指向的对象将有所区别：

• 当元素为Method时，此处层级结构指声明方法的类的层级结构， 扫描器将从层级结构中寻找与该方法签名相同的方法，并对其进行扫描；
• 当元素为Class时，此处层级结构即指类本身与其父类、父接口共同构成的层级结构， 扫描器将扫描层级结构中类、接口声明的注解；
• 当元素不为Method或Class时，则其层级结构仅有其本身一层；

此外，扫描器支持在获取到层级结构中的注解对象后，再对注解对象的元注解进行扫描。

Author:

huangchengxing

See Also:

TypeAnnotationScanner, MethodAnnotationScanner, MetaAnnotationScanner, ElementAnnotationScanner

Field Summary

Fields inherited from interface cn.hutool.core.annotation.scanner.AnnotationScanner

DIRECTLY, DIRECTLY_AND_META_ANNOTATION, INTERFACE, INTERFACE_AND_META_ANNOTATION, NOTHING, SUPERCLASS, SUPERCLASS_AND_META_ANNOTATION, TYPE_HIERARCHY, TYPE_HIERARCHY_AND_META_ANNOTATION

Constructor Summary

Constructors

Constructor and Description
GenericAnnotationScanner(boolean enableScanMetaAnnotation, boolean enableScanSupperClass, boolean enableScanSupperInterface) 构造一个通用注解扫描器

Method Summary

Modifier and Type	Method and Description
void	scan(BiConsumer<Integer,Annotation> consumer, AnnotatedElement annotatedEle, Predicate<Annotation> filter) 扫描注解元素的层级结构（若存在），然后对获取到的注解和注解对应的层级索引进行处理
boolean	support(AnnotatedElement annotatedEle) 通用注解扫描器支持扫描所有类型的AnnotatedElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface cn.hutool.core.annotation.scanner.AnnotationScanner

getAnnotations, getAnnotationsIfSupport, scanByAllSupported, scanByAnySupported, scanIfSupport

Constructor Detail

GenericAnnotationScanner

public GenericAnnotationScanner(boolean enableScanMetaAnnotation,
                                boolean enableScanSupperClass,
                                boolean enableScanSupperInterface)

构造一个通用注解扫描器

Parameters:

enableScanMetaAnnotation - 是否扫描注解上的元注解

enableScanSupperClass - 是否扫描父类

enableScanSupperInterface - 是否扫描父接口

Method Detail

support

public boolean support(AnnotatedElement annotatedEle)

通用注解扫描器支持扫描所有类型的AnnotatedElement

Specified by:

support in interface AnnotationScanner

Parameters:

annotatedEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission

Returns:

是否支持扫描该注解元素

scan

public void scan(BiConsumer<Integer,Annotation> consumer,
                 AnnotatedElement annotatedEle,
                 Predicate<Annotation> filter)

扫描注解元素的层级结构（若存在），然后对获取到的注解和注解对应的层级索引进行处理

Specified by:

scan in interface AnnotationScanner

Parameters:

consumer - 对获取到的注解和注解对应的层级索引的处理

annotatedEle - AnnotatedElement，可以是Class、Method、Field、Constructor、ReflectPermission

filter - 注解过滤器，无法通过过滤器的注解不会被处理。该参数允许为空。