org.dromara.hutool.core.annotation.elements

类 MetaAnnotatedElement<T extends AnnotationMapping<Annotation>>

java.lang.Object

org.dromara.hutool.core.annotation.elements.MetaAnnotatedElement<T>

类型参数:

T - AnnotationMapping类型

所有已实现的接口:

Iterable<T>, AnnotatedElement

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

注解元素映射，用于包装一个AnnotatedElement，然后将被包装的元素上， 直接声明的注解以及这些注解的元组全部解析为ResolvedAnnotationMapping。 从而用于支持对元注解的访问操作。

默认情况下，总是不扫描java.lang包下的注解， 并且在当前实例中，Inherited注解将不生效， 即通过directly方法将无法获得父类上带有Inherited的注解。

在一个MetaAnnotatedElement中， AnnotatedElement上同类型的注解或元注解只会被保留一个， 即当出现两个根注解都具有相同元注解时，仅有第一个根注解上的元注解会被保留， 因此当通过getAnnotationsByType(Class) 或getDeclaredAnnotationsByType(Class)方法用于只能获得一个注解对象。

作者:

huangchengxing

从以下版本开始:

6.0.0

另请参阅:

ResolvedAnnotationMapping

构造器概要

构造器

构造器和说明
MetaAnnotatedElement(AnnotatedElement element, BiFunction<T,Annotation,T> mappingFactory) 解析注解属性

方法概要

限定符和类型	方法和说明
static <A extends AnnotationMapping<Annotation>> MetaAnnotatedElement<A>	create(AnnotatedElement element, BiFunction<A,Annotation,A> mappingFactory) 获取AnnotatedElement上的注解结构，该方法会针对相同的AnnotatedElement缓存映射对象
boolean	equals(Object o) 比较两个实例是否相等
<A extends Annotation> A	getAnnotation(Class<A> annotationType) 从AnnotatedElement直接声明的注解的层级结构中获得注解对象
protected Map<Class<? extends Annotation>,T>	getAnnotationMappings() 获取注解映射，若当前实例未完成初始化则先进行初始化
Annotation[]	getAnnotations() 获取所有注解
<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直接声明的指定类型注解
Optional<T>	getDeclaredMapping(Class<? extends Annotation> annotationType) 从AnnotatedElement直接声明的注解中获得注解映射对象
AnnotatedElement	getElement() 获取被包装的AnnotatedElement
Optional<T>	getMapping(Class<? extends Annotation> annotationType) 从AnnotatedElement直接声明的注解的层级结构中获得注解映射对象
int	hashCode() 获取实例的哈希值
boolean	isAnnotationPresent(Class<? extends Annotation> annotationType) 注解是否是AnnotatedElement直接声明的注解，或者在这些注解的层级结构中存在
protected boolean	isNeedMapping(Map<Class<? extends Annotation>,T> mappings, Annotation annotation) 该注解是否需要映射 默认情况下，已经处理过、或在java.lang包下的注解不会被处理
Iterator<T>	iterator() 获取注解映射对象集合的迭代器

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

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

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

forEach, spliterator

构造器详细资料

MetaAnnotatedElement

public MetaAnnotatedElement(AnnotatedElement element,
                            BiFunction<T,Annotation,T> mappingFactory)

解析注解属性

参数:

element - 被注解元素

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

方法详细资料

create

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

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

类型参数:

A - AnnotationMapping类型

参数:

element - 被注解元素

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

返回:

AnnotatedElement上的注解结构

getMapping

public Optional<T> getMapping(Class<? extends Annotation> annotationType)

从AnnotatedElement直接声明的注解的层级结构中获得注解映射对象

参数:

annotationType - 注解类型

返回:

注解映射对象

getElement

public AnnotatedElement getElement()

获取被包装的AnnotatedElement

返回:

被包装的AnnotatedElement

getDeclaredMapping

public Optional<T> getDeclaredMapping(Class<? extends Annotation> annotationType)

从AnnotatedElement直接声明的注解中获得注解映射对象

参数:

annotationType - 注解类型

返回:

注解映射对象

isAnnotationPresent

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

注解是否是AnnotatedElement直接声明的注解，或者在这些注解的层级结构中存在

指定者:

isAnnotationPresent 在接口中 AnnotatedElement

参数:

annotationType - 注解元素

返回:

是否

getAnnotation

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

从AnnotatedElement直接声明的注解的层级结构中获得注解对象

指定者:

getAnnotation 在接口中 AnnotatedElement

类型参数:

A - 注解类型

参数:

annotationType - 注解类型

返回:

注解对象

getDeclaredAnnotation

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

从AnnotatedElement直接声明的注解中获得注解对象

指定者:

getDeclaredAnnotation 在接口中 AnnotatedElement

类型参数:

A - 注解类型

参数:

annotationType - 注解类型

返回:

注解对象

getAnnotationsByType

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

获取AnnotatedElement直接的指定类型注解

指定者:

getAnnotationsByType 在接口中 AnnotatedElement

类型参数:

A - 注解类型

参数:

annotationType - 注解类型

返回:

AnnotatedElement直接声明的指定类型注解

getDeclaredAnnotationsByType

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

获取AnnotatedElement直接声明的指定类型注解

指定者:

getDeclaredAnnotationsByType 在接口中 AnnotatedElement

类型参数:

A - 注解类型

参数:

annotationType - 注解类型

返回:

AnnotatedElement直接声明的指定类型注解

getDeclaredAnnotations

public Annotation[] getDeclaredAnnotations()

获取AnnotatedElement直接声明的注解的映射对象

指定者:

getDeclaredAnnotations 在接口中 AnnotatedElement

返回:

AnnotatedElement直接声明的注解的映射对象

getAnnotations

public Annotation[] getAnnotations()

获取所有注解

指定者:

getAnnotations 在接口中 AnnotatedElement

返回:

所有注解

iterator

public Iterator<T> iterator()

获取注解映射对象集合的迭代器

指定者:

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

返回:

迭代器

equals

public boolean equals(Object o)

比较两个实例是否相等

覆盖:

equals 在类中 Object

参数:

o - 对象

返回:

是否

hashCode

public int hashCode()

获取实例的哈希值

覆盖:

hashCode 在类中 Object

返回:

哈希值

getAnnotationMappings

protected final Map<Class<? extends Annotation>,T> getAnnotationMappings()

获取注解映射，若当前实例未完成初始化则先进行初始化

返回:

不可变的注解映射集合

isNeedMapping

protected boolean isNeedMapping(Map<Class<? extends Annotation>,T> mappings,
                                Annotation annotation)

该注解是否需要映射
默认情况下，已经处理过、或在java.lang包下的注解不会被处理

参数:

mappings - 当前已处理的注解

annotation - 注解对象

返回:

是否