cn.hutool.core.annotation

Interface SynthesizedAnnotation

All Superinterfaces:

Annotation, AnnotationAttributeValueProvider, Comparable<Hierarchical>, Hierarchical

All Known Implementing Classes:

GenericSynthesizedAggregateAnnotation.MetaAnnotation, GenericSynthesizedAnnotation

public interface SynthesizedAnnotation
extends Annotation, Hierarchical, AnnotationAttributeValueProvider

用于在SynthesizedAggregateAnnotation中表示一个处于合成状态的注解对象。
当对多个合成注解排序时，默认使用Hierarchical.DEFAULT_HIERARCHICAL_COMPARATOR进行排序， 从保证合成注解按getVerticalDistance()与getHorizontalDistance()的返回值保持有序， 从而使得距离根元素更接近的注解对象在被处理是具有更高的优先级。

Author:

huangchengxing

See Also:

SynthesizedAggregateAnnotation

Nested Class Summary

Nested classes/interfaces inherited from interface cn.hutool.core.annotation.Hierarchical

Hierarchical.Selector

Field Summary

Fields inherited from interface cn.hutool.core.annotation.Hierarchical

DEFAULT_HIERARCHICAL_COMPARATOR

Method Summary

Modifier and Type	Method and Description
Annotation	getAnnotation() 获取被合成的注解对象
Map<String,AnnotationAttribute>	getAttributes() 获取该注解的全部属性
Object	getAttributeValue(String attributeName) 获取属性值
int	getHorizontalDistance() 获取该合成注解与根对象的水平距离。
int	getVerticalDistance() 获取该合成注解与根对象的垂直距离。
boolean	hasAttribute(String attributeName, Class<?> returnType) 注解是否存在该名称相同，且类型一致的属性
void	replaceAttribute(String attributeName, UnaryOperator<AnnotationAttribute> operator) 替换属性值
void	setAttribute(String attributeName, AnnotationAttribute attribute) 设置属性值
default void	setAttributes(Map<String,AnnotationAttribute> attributes) 设置该注解的全部属性

Methods inherited from interface java.lang.annotation.Annotation

annotationType, equals, hashCode, toString

Methods inherited from interface cn.hutool.core.annotation.Hierarchical

compareTo, getRoot

Methods inherited from interface cn.hutool.core.annotation.AnnotationAttributeValueProvider

getAttributeValue

Method Detail

getAnnotation

Annotation getAnnotation()

获取被合成的注解对象

Returns:

注解对象

getVerticalDistance

int getVerticalDistance()

获取该合成注解与根对象的垂直距离。 默认情况下，该距离即为当前注解与根对象之间相隔的层级数。

Specified by:

getVerticalDistance in interface Hierarchical

Returns:

合成注解与根对象的垂直距离

getHorizontalDistance

int getHorizontalDistance()

获取该合成注解与根对象的水平距离。 默认情况下，该距离即为当前注解与根对象之间相隔的已经被扫描到的注解数。

Specified by:

getHorizontalDistance in interface Hierarchical

Returns:

合成注解与根对象的水平距离

hasAttribute

boolean hasAttribute(String attributeName,
                     Class<?> returnType)

注解是否存在该名称相同，且类型一致的属性

Parameters:

attributeName - 属性名

returnType - 返回值类型

Returns:

是否存在该属性

getAttributes

Map<String,AnnotationAttribute> getAttributes()

获取该注解的全部属性

Returns:

注解属性

setAttributes

default void setAttributes(Map<String,AnnotationAttribute> attributes)

设置该注解的全部属性

Parameters:

attributes - 注解属性

setAttribute

void setAttribute(String attributeName,
                  AnnotationAttribute attribute)

设置属性值

Parameters:

attributeName - 属性名称

attribute - 注解属性

replaceAttribute

void replaceAttribute(String attributeName,
                      UnaryOperator<AnnotationAttribute> operator)

替换属性值

Parameters:

attributeName - 属性名

operator - 替换操作

getAttributeValue

Object getAttributeValue(String attributeName)

获取属性值

Parameters:

attributeName - 属性名

Returns:

属性值