org.aoju.bus.core.toolkit

Class AnnoKit

java.lang.Object

org.aoju.bus.core.toolkit.AnnoKit

public class AnnoKit
extends Object

注解工具类 快速获取注解对象、注解值等工具封装

Since:

JDK 1.8+

Version:

6.0.2

Author:

Kimi Liu

Constructor Summary

Constructors

Constructor and Description
AnnoKit()

Method Summary

Modifier and Type	Method and Description
static <A extends Annotation> A	getAnnotation(AnnotatedElement annotationEle, Class<A> annotationType) 获取指定注解
static Annotation[]	getAnnotations(AnnotatedElement annotationEle, boolean isCombination) 获取指定注解
static <T> T	getAnnotationValue(AnnotatedElement annotationEle, Class<? extends Annotation> annotationType) 获取指定注解默认值 如果无指定的属性方法返回null
static <T> T	getAnnotationValue(AnnotatedElement annotationEle, Class<? extends Annotation> annotationType, String propertyName) 获取指定注解属性的值 如果无指定的属性方法返回null
static Map<String,Object>	getAnnotationValueMap(AnnotatedElement annotationEle, Class<? extends Annotation> annotationType) 获取指定注解中所有属性值 如果无指定的属性方法返回null
static RetentionPolicy	getRetentionPolicy(Class<? extends Annotation> annotationType) 获取注解类的保留时间,可选值 SOURCE(源码时),CLASS(编译时),RUNTIME(运行时),默认为 CLASS
static ElementType[]	getTargetType(Class<? extends Annotation> annotationType) 获取注解类可以用来修饰哪些程序元素,如 TYPE, METHOD, CONSTRUCTOR, FIELD, PARAMETER 等
static boolean	isDocumented(Class<? extends Annotation> annotationType) 是否会保存到 Javadoc 文档中
static boolean	isInherited(Class<? extends Annotation> annotationType) 是否可以被继承,默认为 false
static Element	toCombination(AnnotatedElement annotationEle) 将指定的被注解的元素转换为组合注解元素

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnoKit

public AnnoKit()

Method Detail

toCombination

public static Element toCombination(AnnotatedElement annotationEle)

将指定的被注解的元素转换为组合注解元素

Parameters:

annotationEle - 注解元素

Returns:

组合注解元素

getAnnotations

public static Annotation[] getAnnotations(AnnotatedElement annotationEle,
                                          boolean isCombination)

获取指定注解

Parameters:

annotationEle - AnnotatedElement,可以是Class、Method、Field、Constructor、ReflectPermission

isCombination - boolean

Returns:

注解对象

getAnnotation

public static <A extends Annotation> A getAnnotation(AnnotatedElement annotationEle,
                                                     Class<A> annotationType)

获取指定注解

Type Parameters:

A - 注解类型

Parameters:

annotationEle - AnnotatedElement,可以是Class、Method、Field、Constructor、ReflectPermission

annotationType - 注解类型

Returns:

注解对象

getAnnotationValue

public static <T> T getAnnotationValue(AnnotatedElement annotationEle,
                                       Class<? extends Annotation> annotationType)

获取指定注解默认值 如果无指定的属性方法返回null

Type Parameters:

T - 注解值类型

Parameters:

annotationEle - AccessibleObject,可以是Class、Method、Field、Constructor、ReflectPermission

annotationType - 注解类型

Returns:

注解对象

getAnnotationValue

public static <T> T getAnnotationValue(AnnotatedElement annotationEle,
                                       Class<? extends Annotation> annotationType,
                                       String propertyName)

获取指定注解属性的值 如果无指定的属性方法返回null

Type Parameters:

T - 注解值类型

Parameters:

annotationEle - AccessibleObject,可以是Class、Method、Field、Constructor、ReflectPermission

annotationType - 注解类型

propertyName - 属性名,例如注解中定义了name()方法,则 此处传入name

Returns:

注解对象

getAnnotationValueMap

public static Map<String,Object> getAnnotationValueMap(AnnotatedElement annotationEle,
                                                       Class<? extends Annotation> annotationType)

获取指定注解中所有属性值 如果无指定的属性方法返回null

Parameters:

annotationEle - AnnotatedElement,可以是Class、Method、Field、Constructor、ReflectPermission

annotationType - 注解类型

Returns:

注解对象

getRetentionPolicy

public static RetentionPolicy getRetentionPolicy(Class<? extends Annotation> annotationType)

获取注解类的保留时间,可选值 SOURCE(源码时),CLASS(编译时),RUNTIME(运行时),默认为 CLASS

Parameters:

annotationType - 注解类

Returns:

保留时间枚举

getTargetType

public static ElementType[] getTargetType(Class<? extends Annotation> annotationType)

获取注解类可以用来修饰哪些程序元素,如 TYPE, METHOD, CONSTRUCTOR, FIELD, PARAMETER 等

Parameters:

annotationType - 注解类

Returns:

注解修饰的程序元素数组

isDocumented

public static boolean isDocumented(Class<? extends Annotation> annotationType)

是否会保存到 Javadoc 文档中

Parameters:

annotationType - 注解类

Returns:

是否会保存到 Javadoc 文档中

isInherited

public static boolean isInherited(Class<? extends Annotation> annotationType)

是否可以被继承,默认为 false

Parameters:

annotationType - 注解类

Returns:

是否会保存到 Javadoc 文档中