HierarchicalAnnotatedElements (hutool-core 6.0.0-M12 API)

java.lang.Object
- org.dromara.hutool.core.annotation.elements.HierarchicalAnnotatedElements

所有已实现的接口:

Iterable<AnnotatedElement>, AnnotatedElement
```
public class HierarchicalAnnotatedElements
extends Object
implements AnnotatedElement, Iterable<AnnotatedElement>
```
表示一组处于在层级结构中具有关联关系的AnnotatedElement，创建实例时，将扫描指定AnnotatedElement的层级结构中的所有AnnotatedElement, 并将其包装为MetaAnnotatedElement。
eg:
若存在元素A有对应父类与父接口B，C，则根据A生成的HierarchicalAnnotatedElements实例将同时包含A，B，C, 该实例同时支持对这三个实例上直接声明的注解，以及这些注解的元注解进行访问。
注解搜索范围
在当前实例中，针对带有和不带declared关键字的方法定义如下：
- 当方法带有declared关键字时，查找范围仅限被保存的所有AnnotatedElement上直接声明的注解；
- 当方法不带declared关键字时，查找范围包括：
  1. 被保存的所有AnnotatedElement上直接声明的注解，及这些注解的元注解；
  2. 若是类，则包括其所有父类和所有父接口上声明的注解和元注解；
  3. 若是方法，且不是静态/私有/被final修饰的方法时，则额外获取包括其声明类的所有父类和所有父接口中，与该方法具有相同方法签名的方法上的注解和元注解；
扫描顺序
当AnnotatedElement具有层级结构式，会按照广度优先扫描其本身(元素是Class)、或其声明类(元素是Method)的层级结构。
在该过程中，总是先扫描父类，再扫描父接口，若存在多个父接口，则其扫描顺序遵循从Class.getInterfaces()获得该接口的顺序。
作者:

huangchengxing

从以下版本开始:

6.0.0

字段概要

字段
限定符和类型	字段和说明
`protected BiFunction<Set<AnnotatedElement>,AnnotatedElement,AnnotatedElement>`	`elementFactory` 创建`AnnotatedElement`的工厂方法，当返回`null`时将忽略该元素
`protected AnnotatedElement`	`source` 被包装的`AnnotatedElement`对象

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`equals(Object o)` 比较两个实例是否相等
`<A extends Annotation> A`	`getAnnotation(Class<A> annotationType)` 从层级结构中所有`AnnotatedElement`上的注解和元注解中获取指定类型的注解
`Annotation[]`	`getAnnotations()` 从层级结构中所有`AnnotatedElement`上的注解和元注解中获取指定类型的注解
`<A extends Annotation> A[]`	`getAnnotationsByType(Class<A> annotationType)` 从层级结构中所有`AnnotatedElement`上的注解和元注解中获取指定类型的注解
`<A extends Annotation> A`	`getDeclaredAnnotation(Class<A> annotationType)` 获取层级结构中所有`AnnotatedElement`上直接声明的指定类型注解
`Annotation[]`	`getDeclaredAnnotations()` 获取层级结构中所有`AnnotatedElement`上直接声明的注解
`<A extends Annotation> A[]`	`getDeclaredAnnotationsByType(Class<A> annotationType)` 获取层级结构中所有`AnnotatedElement`上直接声明的指定类型注解
`AnnotatedElement`	`getElement()` 获取被包装的原始`AnnotatedElement`对象
`Set<AnnotatedElement>`	`getElementMappings()` 获取当前元素及层级结构中的关联元素的映射对象，结果只读
`int`	`hashCode()` 获取实例的哈希值
`boolean`	`isAnnotationPresent(Class<? extends Annotation> annotationType)` 注解是否在层级结构中所有`AnnotatedElement`上的注解和元注解中存在
`protected boolean`	`isMatchMethod(Method source, Method target)` 检验方法的签名是否与原始方法匹配
`Iterator<AnnotatedElement>`	`iterator()` 获取注解元素映射集合的迭代器
`static HierarchicalAnnotatedElements`	`of(AnnotatedElement element)` 创建一个分层注解元素
`static HierarchicalAnnotatedElements`	`of(AnnotatedElement element, BiFunction<Set<AnnotatedElement>,AnnotatedElement,AnnotatedElement> elementFactory)` 创建一个分层注解元素

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 java.lang.Iterable
forEach, spliterator

- 字段详细资料
  - elementFactory
```
protected final BiFunction<Set<AnnotatedElement>,AnnotatedElement,AnnotatedElement> elementFactory
```
    创建AnnotatedElement的工厂方法，当返回null时将忽略该元素
  - source
```
protected final AnnotatedElement source
```
    被包装的AnnotatedElement对象
- 方法详细资料
  - of
```
public static HierarchicalAnnotatedElements of(AnnotatedElement element)
```
    创建一个分层注解元素
    
    参数:
    
    element - 被包装的元素，若元素已是HierarchicalAnnotatedElements，则返回其本身
    
    返回:
    
    HierarchicalAnnotatedElements实例，当element也是一个HierarchicalAnnotatedElements时，返回element本身
  - of
```
public static HierarchicalAnnotatedElements of(AnnotatedElement element,
                                               BiFunction<Set<AnnotatedElement>,AnnotatedElement,AnnotatedElement> elementFactory)
```
    创建一个分层注解元素
    
    参数:
    
    element - 被包装的元素，若元素已是HierarchicalAnnotatedElements，则返回其本身
    
    elementFactory - 创建AnnotatedElement的工厂方法，当返回null时将忽略该元素
    
    返回:
    
    HierarchicalAnnotatedElements实例，当element也是一个HierarchicalAnnotatedElements时，返回element本身
  - isAnnotationPresent
```
public boolean isAnnotationPresent(Class<? extends Annotation> annotationType)
```
    注解是否在层级结构中所有AnnotatedElement上的注解和元注解中存在
    
    指定者:
    
    isAnnotationPresent 在接口中 AnnotatedElement
    
    参数:
    
    annotationType - 注解类型
    
    返回:
    
    是否
  - getAnnotations
```
public Annotation[] getAnnotations()
```
    从层级结构中所有AnnotatedElement上的注解和元注解中获取指定类型的注解
    
    指定者:
    
    getAnnotations 在接口中 AnnotatedElement
    
    返回:
    
    注解对象
  - getAnnotation
```
public <A extends Annotation> A getAnnotation(Class<A> annotationType)
```
    从层级结构中所有AnnotatedElement上的注解和元注解中获取指定类型的注解
    
    指定者:
    
    getAnnotation 在接口中 AnnotatedElement
    
    类型参数:
    
    A - 注解类型
    
    参数:
    
    annotationType - 注解类型
    
    返回:
    
    注解对象
  - getAnnotationsByType
```
public <A extends Annotation> A[] getAnnotationsByType(Class<A> annotationType)
```
    从层级结构中所有AnnotatedElement上的注解和元注解中获取指定类型的注解
    
    指定者:
    
    getAnnotationsByType 在接口中 AnnotatedElement
    
    类型参数:
    
    A - 注解类型
    
    参数:
    
    annotationType - 注解类型
    
    返回:
    
    注解对象
  - getDeclaredAnnotations
```
public Annotation[] getDeclaredAnnotations()
```
    获取层级结构中所有AnnotatedElement上直接声明的注解
    
    指定者:
    
    getDeclaredAnnotations 在接口中 AnnotatedElement
    
    返回:
    
    注解对象
  - getDeclaredAnnotation
```
public <A extends Annotation> A getDeclaredAnnotation(Class<A> annotationType)
```
    获取层级结构中所有AnnotatedElement上直接声明的指定类型注解
    
    指定者:
    
    getDeclaredAnnotation 在接口中 AnnotatedElement
    
    类型参数:
    
    A - 注解类型
    
    参数:
    
    annotationType - 注解类型
    
    返回:
    
    注解对象
  - getDeclaredAnnotationsByType
```
public <A extends Annotation> A[] getDeclaredAnnotationsByType(Class<A> annotationType)
```
    获取层级结构中所有AnnotatedElement上直接声明的指定类型注解
    
    指定者:
    
    getDeclaredAnnotationsByType 在接口中 AnnotatedElement
    
    类型参数:
    
    A - 注解类型
    
    参数:
    
    annotationType - 注解类型
    
    返回:
    
    注解对象
  - iterator
```
public Iterator<AnnotatedElement> iterator()
```
    获取注解元素映射集合的迭代器
    
    指定者:
    
    iterator 在接口中 Iterable<AnnotatedElement>
    
    返回:
    
    迭代器
  - getElement
```
public AnnotatedElement getElement()
```
    获取被包装的原始AnnotatedElement对象
    
    返回:
    
    注解对象
  - equals
```
public boolean equals(Object o)
```
    比较两个实例是否相等
    
    覆盖:
    
    equals 在类中 Object
    
    参数:
    
    o - 对象
    
    返回:
    
    是否
  - hashCode
```
public int hashCode()
```
    获取实例的哈希值
    
    覆盖:
    
    hashCode 在类中 Object
    
    返回:
    
    哈希值
  - getElementMappings
```
public final Set<AnnotatedElement> getElementMappings()
```
    获取当前元素及层级结构中的关联元素的映射对象，结果只读
    
    返回:
    
    元素映射对象
  - isMatchMethod
```
protected boolean isMatchMethod(Method source,
                                Method target)
```
    检验方法的签名是否与原始方法匹配
    
    参数:
    
    source - 原始的方法
    
    target - 比较的方法
    
    返回:
    
    是否

类 HierarchicalAnnotatedElements

字段概要

方法概要

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

从接口继承的方法 java.lang.Iterable

字段详细资料

elementFactory

source

方法详细资料

of

of

isAnnotationPresent

getAnnotations

getAnnotation

getAnnotationsByType

getDeclaredAnnotations

getDeclaredAnnotation

getDeclaredAnnotationsByType

iterator

getElement

equals

hashCode

getElementMappings

isMatchMethod