top.xiajibagao.powerfulannotation.scanner

枚举 AnnotationSearchMode

java.lang.Object

java.lang.Enum<AnnotationSearchMode>

top.xiajibagao.powerfulannotation.scanner.AnnotationSearchMode

所有已实现的接口:

Serializable, Comparable<AnnotationSearchMode>

public enum AnnotationSearchMode
extends Enum<AnnotationSearchMode>

用于从AnnotatedElement及其层级结构扫描注解的扫描模式封装

层级结构扫描支持

扫描模式按照对层级结构的扫描范围分为四类，每一类分别对应一个关键词：

• SELF：只扫描元素本身；
• SUPERCLASS：扫描元素本身以及层级结构中的父类；
• INTERFACE：扫描元素本身以及层级结构中的接口；
• TYPE_HIERARCHY：扫描元素本身以及层级结构中的父类与父接口；

元注解扫描支持

扫描模式按照对注解的元注解结构的扫描范围分为两类，每一类分别对应一个关键词：

• INDIRECT：从层级结构中扫描到注解后，还会继续扫描这些注解的元注解。
  eg：X上存在注解A，A上存在元注解B，则扫描X，将获得A和B；
• DIRECT：从层级结构中扫描到注解后，不会继续扫描它们的元注解；
  eg：X上存在注解A，A上存在元注解B，则扫描X，将只获得A；

注意

• 提供的策略皆不会扫描com.sun，java.lang及javax包下的类的注解；
• 提供的策略皆不会重复扫描一个已经扫描过的普通类，并且在扫描注解类时，该类层级结构中的一种类型的元注解只会被扫描一次；
• 当查找的元素为注解类，即元素类型为Class、且Class.isAnnotation()返回true时， 必须选择INDIRECT类型的策略才会完整的扫描其层级结构中的元注解， 其余策略皆仅会扫描该注解类直接声明的元注解；

作者:

huangchengxing

另请参阅:

AbstractAnnotationScanner

枚举常量概要

枚举常量

枚举常量和说明
INTERFACE_AND_DIRECT 扫描元素本身以及层级结构中的父接口声明的注解
INTERFACE_AND_INDIRECT 扫描元素本身以及层级结构中的父接口声明的注解，以及这些注解的元注解
SELF_AND_DIRECT 扫描元素本身直接声明的注解，包括父类带有Inherited、被传递到元素上的注解
SELF_AND_INDIRECT 扫描元素本身直接声明的注解，包括父类带有Inherited、被传递到元素上的注解，以及这些注解的元注解
SUPERCLASS_AND_DIRECT 扫描元素本身以及层级结构中的父类声明的注解
SUPERCLASS_AND_INDIRECT 扫描元素本身以及层级结构中的父类声明的注解，以及这些注解的元注解
TYPE_HIERARCHY_AND_DIRECT 扫描元素本身以及层级结构中的父类及父接口声明的注解
TYPE_HIERARCHY_AND_INDIRECT 扫描元素本身以及层级结构中的父类及父接口声明的注解，以及这些注解的元注解

字段概要

字段

限定符和类型	字段和说明
protected AbstractAnnotationScanner	scanner 注解扫描器

方法概要

限定符和类型	方法和说明
<T> T	getAnnotation(AnnotatedElement element, AnnotationFilter filter, Predicate<T> predicate, Function3<Integer,Integer,Annotation,T> converter) 从元素获取注解并将其转为指定类型对象，若符合条件则返回该指定类型对象
<T extends Annotation> T	getAnnotation(AnnotatedElement element, Class<T> annotationType) 从元素获取类型注解
List<Annotation>	getAnnotations(AnnotatedElement element, AnnotationFilter filter) 从元素获取全部注解
<T> List<T>	getAnnotations(AnnotatedElement element, AnnotationFilter filter, Function3<Integer,Integer,Annotation,T> converter) 从元素获取全部注解并将其转为指定类型
<T extends Annotation> List<T>	getAnnotations(AnnotatedElement element, Class<T> annotationType) 从元素获取指定类型的注解
ScanOptions	getOptions() 获得与该策略一致的扫描器配置对象
boolean	isAnnotationPresent(AnnotatedElement element, Class<? extends Annotation> annotationType) 元素是否存在该类型的注解
void	scan(AnnotatedElement element, AnnotationProcessor processor, AnnotationFilter filter) 扫描与指定元素具有关联的注解，并对其进行处理
static AnnotationSearchMode	valueOf(String name) 返回带有指定名称的该类型的枚举常量。
static AnnotationSearchMode[]	values() 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。

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

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

getClass, notify, notifyAll, wait, wait, wait

枚举常量详细资料

SELF_AND_DIRECT

public static final AnnotationSearchMode SELF_AND_DIRECT

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

SELF_AND_INDIRECT

public static final AnnotationSearchMode SELF_AND_INDIRECT

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

SUPERCLASS_AND_DIRECT

public static final AnnotationSearchMode SUPERCLASS_AND_DIRECT

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

SUPERCLASS_AND_INDIRECT

public static final AnnotationSearchMode SUPERCLASS_AND_INDIRECT

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

INTERFACE_AND_DIRECT

public static final AnnotationSearchMode INTERFACE_AND_DIRECT

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

INTERFACE_AND_INDIRECT

public static final AnnotationSearchMode INTERFACE_AND_INDIRECT

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

TYPE_HIERARCHY_AND_DIRECT

public static final AnnotationSearchMode TYPE_HIERARCHY_AND_DIRECT

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

TYPE_HIERARCHY_AND_INDIRECT

public static final AnnotationSearchMode TYPE_HIERARCHY_AND_INDIRECT

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

字段详细资料

scanner

protected final AbstractAnnotationScanner scanner

注解扫描器

方法详细资料

values

public static AnnotationSearchMode[] values()

按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:

for (AnnotationSearchMode c : AnnotationSearchMode.values())
    System.out.println(c);

返回:

按照声明该枚举类型的常量的顺序返回的包含这些常量的数组

valueOf

public static AnnotationSearchMode valueOf(String name)

返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符完全匹配。(不允许有多余 的空格字符。)

参数:

name - 要返回的枚举常量的名称。

返回:

返回带有指定名称的枚举常量

抛出:

IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量

NullPointerException - 如果参数为空值

getOptions

public ScanOptions getOptions()

获得与该策略一致的扫描器配置对象

返回:

扫描器配置对象

getAnnotations

public <T> List<T> getAnnotations(AnnotatedElement element,
                                  AnnotationFilter filter,
                                  Function3<Integer,Integer,Annotation,T> converter)

从元素获取全部注解并将其转为指定类型

类型参数:

T - 转换类型

参数:

element - 要扫描的元素

filter - 注解过滤器

converter - 转换器

返回:

注解对象

getAnnotations

public List<Annotation> getAnnotations(AnnotatedElement element,
                                       AnnotationFilter filter)

从元素获取全部注解

参数:

element - 要扫描的元素

filter - 注解过滤器

返回:

注解对象

getAnnotations

public <T extends Annotation> List<T> getAnnotations(AnnotatedElement element,
                                                     Class<T> annotationType)

从元素获取指定类型的注解

参数:

element - 要扫描的元素

annotationType - 注解类型

返回:

注解对象

getAnnotation

public <T> T getAnnotation(AnnotatedElement element,
                           AnnotationFilter filter,
                           Predicate<T> predicate,
                           Function3<Integer,Integer,Annotation,T> converter)

从元素获取注解并将其转为指定类型对象，若符合条件则返回该指定类型对象

类型参数:

T - 转换类型

参数:

element - 要扫描的元素

filter - 注解过滤器

predicate - 目标的判断条件

converter - 转换器

返回:

注解对象

getAnnotation

public <T extends Annotation> T getAnnotation(AnnotatedElement element,
                                              Class<T> annotationType)

从元素获取类型注解

类型参数:

T - 注解类型

参数:

element - 要扫描的元素

annotationType - 注解类型

返回:

注解对象

isAnnotationPresent

public boolean isAnnotationPresent(AnnotatedElement element,
                                   Class<? extends Annotation> annotationType)

元素是否存在该类型的注解

参数:

element - 要扫描的元素

annotationType - 注解类型

返回:

是否

scan

public void scan(AnnotatedElement element,
                 AnnotationProcessor processor,
                 AnnotationFilter filter)

扫描与指定元素具有关联的注解，并对其进行处理

参数:

element - 要扫描的元素

processor - 注解处理器

filter - 过滤器