org.dromara.hutool.core.annotation

类 RepeatableMetaAnnotatedElement<T extends AnnotationMapping<Annotation>>

java.lang.Object

org.dromara.hutool.core.annotation.RepeatableMetaAnnotatedElement<T>

类型参数:

T - AnnotationMapping类型

所有已实现的接口:

Iterable<T>, AnnotatedElement

public class RepeatableMetaAnnotatedElement<T extends AnnotationMapping<Annotation>>
extends Object
implements AnnotatedElement, Iterable<T>

支持可重复注解的增强AnnotatedElement， 功能与MetaAnnotatedElement类似，但是存在下述差异：

• 限制以同一根注解延伸出的树结构上——而不是AnnotatedElement上——每种类型注解只能保留一个， 即当AnnotatedElement存在多个根注解有相同的元注解时，这些元注解会都会被扫描到；
• 支持扫描AnnotatedElement可重复注解，即当当前实例指定的RepeatableAnnotationCollector 支持从AnnotatedElement上直接声明的注解中获得可重复注解时， 则将会自动将其展开直到不为容器注解为止。
  eg：
  A上存在注解X，该注解是一个容器注解，内部可重复注解Y， 包含解析后，得到注解X与可重复注解Y,
  同理，若存在X、Y、X的嵌套关系，则解析后获得全部三者；

由于上述机制，当通过实例的getAnnotation(Class)或getDeclaredAnnotation(Class) 方法获得指定类型注解时，若该类型注解存在多个，仅能尽可能获得最先被扫描到的那一个。

作者:

huangchengxing

从以下版本开始:

6.0.0

另请参阅:

RepeatableAnnotationCollector

方法概要

限定符和类型	方法和说明
static <A extends AnnotationMapping<Annotation>> RepeatableMetaAnnotatedElement<A>	create(AnnotatedElement element, BiFunction<A,Annotation,A> mappingFactory) 获取AnnotatedElement上的注解结构，该方法会针对相同的AnnotatedElement缓存映射对象
static <A extends AnnotationMapping<Annotation>> RepeatableMetaAnnotatedElement<A>	create(RepeatableAnnotationCollector collector, AnnotatedElement element, BiFunction<A,Annotation,A> mappingFactory) 获取AnnotatedElement上的注解结构，该方法会针对相同的AnnotatedElement缓存映射对象
boolean	equals(Object o) 比较两个实例是否相等
<A extends Annotation> A	getAnnotation(Class<A> annotationType) 从element上直接声明的注解、直接声明的注解包含的可重复注解，以及它们的元注解中获得指定类型的注解
Annotation[]	getAnnotations() 获取element上直接声明的注解、直接声明的注解包含的可重复注解，以及它们的元注解
<A extends Annotation> A[]	getAnnotationsByType(Class<A> annotationType) 从element上直接声明的注解、直接声明的注解包含的可重复注解，以及它们的元注解中获得指定类型的注解
<A extends Annotation> A	getDeclaredAnnotation(Class<A> annotationType) 获取由element直接声明的注解，不包含被直接声明的容器注解包括的可重复注解
Annotation[]	getDeclaredAnnotations() 获取由element直接声明的注解，不包含被直接声明的容器注解包括的可重复注解
<A extends Annotation> A[]	getDeclaredAnnotationsByType(Class<A> annotationType) 获取由element直接声明的注解，不包含被直接声明的容器注解包括的可重复注解
AnnotatedElement	getElement() 注解对象
int	hashCode() 获取实例的哈希值
boolean	isAnnotationPresent(Class<? extends Annotation> annotationType) 指定注解是否在element上直接声明的注解、直接声明的注解包含的可重复注解， 以及他们的元注解中存在
Iterator<T>	iterator() 获取迭代器

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

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

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

forEach, spliterator

方法详细资料

create

public static <A extends AnnotationMapping<Annotation>> RepeatableMetaAnnotatedElement<A> create(AnnotatedElement element,
                                                                                                 BiFunction<A,Annotation,A> mappingFactory)

获取AnnotatedElement上的注解结构，该方法会针对相同的AnnotatedElement缓存映射对象

类型参数:

A - AnnotationMapping类型

参数:

element - 被注解元素

mappingFactory - 创建AnnotationMapping的工厂方法，返回值为null时将忽略该注解

返回:

AnnotatedElement上的注解结构

create

public static <A extends AnnotationMapping<Annotation>> RepeatableMetaAnnotatedElement<A> create(RepeatableAnnotationCollector collector,
                                                                                                 AnnotatedElement element,
                                                                                                 BiFunction<A,Annotation,A> mappingFactory)

获取AnnotatedElement上的注解结构，该方法会针对相同的AnnotatedElement缓存映射对象

类型参数:

A - AnnotationMapping类型

参数:

collector - 可重复注解收集器

element - 被注解元素

mappingFactory - 创建AnnotationMapping的工厂方法，返回值为null时将忽略该注解

返回:

AnnotatedElement上的注解结构

isAnnotationPresent

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

指定注解是否在element上直接声明的注解、直接声明的注解包含的可重复注解， 以及他们的元注解中存在

指定者:

isAnnotationPresent 在接口中 AnnotatedElement

参数:

annotationType - 注解类型

返回:

是否

getAnnotation

public <A extends Annotation> A getAnnotation(Class<A> annotationType)

从element上直接声明的注解、直接声明的注解包含的可重复注解，以及它们的元注解中获得指定类型的注解

指定者:

getAnnotation 在接口中 AnnotatedElement

类型参数:

A - 注解类型

参数:

annotationType - 注解类型

返回:

注解

getAnnotations

public Annotation[] getAnnotations()

获取element上直接声明的注解、直接声明的注解包含的可重复注解，以及它们的元注解

指定者:

getAnnotations 在接口中 AnnotatedElement

返回:

注解

getAnnotationsByType

public <A extends Annotation> A[] getAnnotationsByType(Class<A> annotationType)

从element上直接声明的注解、直接声明的注解包含的可重复注解，以及它们的元注解中获得指定类型的注解

指定者:

getAnnotationsByType 在接口中 AnnotatedElement

类型参数:

A - 注解类型

参数:

annotationType - 注解类型

返回:

注解

getDeclaredAnnotations

public Annotation[] getDeclaredAnnotations()

获取由element直接声明的注解，不包含被直接声明的容器注解包括的可重复注解

指定者:

getDeclaredAnnotations 在接口中 AnnotatedElement

返回:

注解

getDeclaredAnnotation

public <A extends Annotation> A getDeclaredAnnotation(Class<A> annotationType)

获取由element直接声明的注解，不包含被直接声明的容器注解包括的可重复注解

指定者:

getDeclaredAnnotation 在接口中 AnnotatedElement

类型参数:

A - 注解类型

参数:

annotationType - 注解类型

返回:

注解

getDeclaredAnnotationsByType

public <A extends Annotation> A[] getDeclaredAnnotationsByType(Class<A> annotationType)

获取由element直接声明的注解，不包含被直接声明的容器注解包括的可重复注解

指定者:

getDeclaredAnnotationsByType 在接口中 AnnotatedElement

类型参数:

A - 注解类型

参数:

annotationType - 注解类型

返回:

注解

getElement

public AnnotatedElement getElement()

注解对象

返回:

被包装的原始元素

equals

public boolean equals(Object o)

比较两个实例是否相等

覆盖:

equals 在类中 Object

参数:

o - 对象

返回:

是否

hashCode

public int hashCode()

获取实例的哈希值

覆盖:

hashCode 在类中 Object

返回:

哈希值

iterator

public Iterator<T> iterator()

获取迭代器

指定者:

iterator 在接口中 Iterable<T extends AnnotationMapping<Annotation>>

返回:

迭代器