cn.hutool.core.annotation

类 AnnotationUtil

java.lang.Object

cn.hutool.core.annotation.AnnotationUtil

public class AnnotationUtil
extends java.lang.Object

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

从以下版本开始:

4.0.9

作者:

looly

构造器概要

构造器

构造器和说明
AnnotationUtil()

方法概要

方法

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

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

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

构造器详细资料

AnnotationUtil

public AnnotationUtil()

方法详细资料

toCombination

public static CombinationAnnotationElement toCombination(java.lang.reflect.AnnotatedElement annotationEle)

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

参数:

annotationEle - 注解元素

返回:

组合注解元素

getAnnotations

public static java.lang.annotation.Annotation[] getAnnotations(java.lang.reflect.AnnotatedElement annotationEle,
                                               boolean isCombination)

获取指定注解

参数:

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

返回:

注解对象

getAnnotation

public static <A extends java.lang.annotation.Annotation> A getAnnotation(java.lang.reflect.AnnotatedElement annotationEle,
                                                          java.lang.Class<A> annotationType)

获取指定注解

类型参数:

A - 注解类型

参数:

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

annotationType - 注解类型

返回:

注解对象

getAnnotationValue

public static <T> T getAnnotationValue(java.lang.reflect.AnnotatedElement annotationEle,
                       java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
                            throws UtilException

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

类型参数:

T - 注解值类型

参数:

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

annotationType - 注解类型

返回:

注解对象

抛出:

UtilException - 调用注解中的方法时执行异常

getAnnotationValue

public static <T> T getAnnotationValue(java.lang.reflect.AnnotatedElement annotationEle,
                       java.lang.Class<? extends java.lang.annotation.Annotation> annotationType,
                       java.lang.String propertyName)
                            throws UtilException

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

类型参数:

T - 注解值类型

参数:

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

annotationType - 注解类型

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

返回:

注解对象

抛出:

UtilException - 调用注解中的方法时执行异常

getAnnotationValueMap

public static java.util.Map<java.lang.String,java.lang.Object> getAnnotationValueMap(java.lang.reflect.AnnotatedElement annotationEle,
                                                                     java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
                                                                              throws UtilException

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

参数:

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

annotationType - 注解类型

返回:

注解对象

抛出:

UtilException - 调用注解中的方法时执行异常

getRetentionPolicy

public static java.lang.annotation.RetentionPolicy getRetentionPolicy(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

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

参数:

annotationType - 注解类

返回:

保留时间枚举

getTargetType

public static java.lang.annotation.ElementType[] getTargetType(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

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

参数:

annotationType - 注解类

返回:

注解修饰的程序元素数组

isDocumented

public static boolean isDocumented(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

是否会保存到 Javadoc 文档中

参数:

annotationType - 注解类

返回:

是否会保存到 Javadoc 文档中

isInherited

public static boolean isInherited(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

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

参数:

annotationType - 注解类

返回:

是否会保存到 Javadoc 文档中