cn.hutool.core.annotation.scanner

Interface AnnotationScanner

All Known Implementing Classes:

AbstractTypeAnnotationScanner, ElementAnnotationScanner, EmptyAnnotationScanner, FieldAnnotationScanner, GenericAnnotationScanner, MetaAnnotationScanner, MethodAnnotationScanner, TypeAnnotationScanner

public interface AnnotationScanner

注解扫描器，用于从支持的可注解元素上获取所需注解

默认提供了以下扫描方式：

• NOTHING：什么都不做，什么注解都不扫描；
• DIRECTLY：扫描元素本身直接声明的注解，包括父类带有Inherited、被传递到元素上的注解；
• DIRECTLY_AND_META_ANNOTATION：扫描元素本身直接声明的注解，包括父类带有Inherited、被传递到元素上的注解， 以及这些注解的元注解；
• SUPERCLASS：扫描元素本身以及父类的层级结构中声明的注解；
• SUPERCLASS_AND_META_ANNOTATION：扫描元素本身以及父类的层级结构中声明的注解，以及这些注解的元注解；
• INTERFACE：扫描元素本身以及父接口的层级结构中声明的注解；
• INTERFACE_AND_META_ANNOTATION：扫描元素本身以及父接口的层级结构中声明的注解，以及这些注解的元注解；
• TYPE_HIERARCHY：扫描元素本身以及父类、父接口的层级结构中声明的注解；
• TYPE_HIERARCHY_AND_META_ANNOTATION：扫描元素本身以及父接口、父接口的层级结构中声明的注解，以及这些注解的元注解；

Author:

huangchengxing

See Also:

TypeAnnotationScanner, MethodAnnotationScanner, FieldAnnotationScanner, MetaAnnotationScanner, ElementAnnotationScanner, GenericAnnotationScanner

Field Summary

Fields

Modifier and Type	Field and Description
static AnnotationScanner	DIRECTLY 扫描元素本身直接声明的注解，包括父类带有Inherited、被传递到元素上的注解的扫描器
static AnnotationScanner	DIRECTLY_AND_META_ANNOTATION 扫描元素本身直接声明的注解，包括父类带有Inherited、被传递到元素上的注解，以及这些注解的元注解的扫描器
static AnnotationScanner	INTERFACE 扫描元素本身以及父接口的层级结构中声明的注解的扫描器
static AnnotationScanner	INTERFACE_AND_META_ANNOTATION 扫描元素本身以及父接口的层级结构中声明的注解，以及这些注解的元注解的扫描器
static AnnotationScanner	NOTHING 不扫描任何注解
static AnnotationScanner	SUPERCLASS 扫描元素本身以及父类的层级结构中声明的注解的扫描器
static AnnotationScanner	SUPERCLASS_AND_META_ANNOTATION 扫描元素本身以及父类的层级结构中声明的注解，以及这些注解的元注解的扫描器
static AnnotationScanner	TYPE_HIERARCHY 扫描元素本身以及父类、父接口的层级结构中声明的注解的扫描器
static AnnotationScanner	TYPE_HIERARCHY_AND_META_ANNOTATION 扫描元素本身以及父接口、父接口的层级结构中声明的注解，以及这些注解的元注解的扫描器

Method Summary

Modifier and Type	Method and Description
default List<Annotation>	getAnnotations(AnnotatedElement annotatedEle) 获取注解元素上的全部注解。
default List<Annotation>	getAnnotationsIfSupport(AnnotatedElement annotatedEle) 若support(AnnotatedElement)返回true， 则调用并返回getAnnotations(AnnotatedElement)结果， 否则返回Collections.emptyList()
default void	scan(BiConsumer<Integer,Annotation> consumer, AnnotatedElement annotatedEle, Predicate<Annotation> filter) 扫描注解元素的层级结构（若存在），然后对获取到的注解和注解对应的层级索引进行处理。
static List<Annotation>	scanByAllSupported(AnnotatedElement annotatedEle, AnnotationScanner... scanners) 根据指定的扫描器，扫描元素上可能存在的注解
static List<Annotation>	scanByAnySupported(AnnotatedElement annotatedEle, AnnotationScanner... scanners) 给定一组扫描器，使用第一个支持处理该类型元素的扫描器获取元素上可能存在的注解
default void	scanIfSupport(BiConsumer<Integer,Annotation> consumer, AnnotatedElement annotatedEle, Predicate<Annotation> filter) 若support(AnnotatedElement)返回true，则调用scan(BiConsumer, AnnotatedElement, Predicate)
default boolean	support(AnnotatedElement annotatedEle) 判断是否支持扫描该注解元素

Field Detail

NOTHING

static final AnnotationScanner NOTHING

不扫描任何注解

DIRECTLY

static final AnnotationScanner DIRECTLY

扫描元素本身直接声明的注解，包括父类带有Inherited、被传递到元素上的注解的扫描器

DIRECTLY_AND_META_ANNOTATION

static final AnnotationScanner DIRECTLY_AND_META_ANNOTATION

扫描元素本身直接声明的注解，包括父类带有Inherited、被传递到元素上的注解，以及这些注解的元注解的扫描器

SUPERCLASS

static final AnnotationScanner SUPERCLASS

扫描元素本身以及父类的层级结构中声明的注解的扫描器

SUPERCLASS_AND_META_ANNOTATION

static final AnnotationScanner SUPERCLASS_AND_META_ANNOTATION

扫描元素本身以及父类的层级结构中声明的注解，以及这些注解的元注解的扫描器

INTERFACE

static final AnnotationScanner INTERFACE

扫描元素本身以及父接口的层级结构中声明的注解的扫描器

INTERFACE_AND_META_ANNOTATION

static final AnnotationScanner INTERFACE_AND_META_ANNOTATION

扫描元素本身以及父接口的层级结构中声明的注解，以及这些注解的元注解的扫描器

TYPE_HIERARCHY

static final AnnotationScanner TYPE_HIERARCHY

扫描元素本身以及父类、父接口的层级结构中声明的注解的扫描器

TYPE_HIERARCHY_AND_META_ANNOTATION

static final AnnotationScanner TYPE_HIERARCHY_AND_META_ANNOTATION

扫描元素本身以及父接口、父接口的层级结构中声明的注解，以及这些注解的元注解的扫描器

Method Detail

scanByAnySupported

static List<Annotation> scanByAnySupported(AnnotatedElement annotatedEle,
                                           AnnotationScanner... scanners)

给定一组扫描器，使用第一个支持处理该类型元素的扫描器获取元素上可能存在的注解

Parameters:

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

scanners - 注解扫描器

Returns:

注解

scanByAllSupported

static List<Annotation> scanByAllSupported(AnnotatedElement annotatedEle,
                                           AnnotationScanner... scanners)

根据指定的扫描器，扫描元素上可能存在的注解

Parameters:

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

scanners - 注解扫描器

Returns:

注解

support

default boolean support(AnnotatedElement annotatedEle)

判断是否支持扫描该注解元素

Parameters:

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

Returns:

是否支持扫描该注解元素

getAnnotations

default List<Annotation> getAnnotations(AnnotatedElement annotatedEle)

获取注解元素上的全部注解。调用该方法前，需要确保调用support(AnnotatedElement)返回为true

Parameters:

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

Returns:

注解

getAnnotationsIfSupport

default List<Annotation> getAnnotationsIfSupport(AnnotatedElement annotatedEle)

若support(AnnotatedElement)返回true， 则调用并返回getAnnotations(AnnotatedElement)结果， 否则返回Collections.emptyList()

Parameters:

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

Returns:

注解

scan

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

扫描注解元素的层级结构（若存在），然后对获取到的注解和注解对应的层级索引进行处理。 调用该方法前，需要确保调用support(AnnotatedElement)返回为true

Parameters:

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

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

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

scanIfSupport

default void scanIfSupport(BiConsumer<Integer,Annotation> consumer,
                           AnnotatedElement annotatedEle,
                           Predicate<Annotation> filter)

若support(AnnotatedElement)返回true，则调用scan(BiConsumer, AnnotatedElement, Predicate)

Parameters:

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

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

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