cn.sexycode.util.core.cls

类 AnnotationUtils

java.lang.Object

cn.sexycode.util.core.cls.AnnotationUtils

public abstract class AnnotationUtils
extends Object

General utility methods for working with annotations, handling meta-annotations, bridge methods (which the compiler generates for generic declarations) as well as super methods (for optional annotation inheritance).

Note that most of the features of this class are not provided by the JDK's introspection facilities themselves.

As a general rule for runtime-retained annotations (e.g. for transaction control, authorization, or service exposure), always use the lookup methods on this class (e.g., findAnnotation(Method, Class), getAnnotation(Method, Class), and getAnnotations(Method)) instead of the plain annotation lookup methods in the JDK. You can still explicitly choose between a get lookup on the given class level only (getAnnotation(Method, Class)) and a find lookup in the entire inheritance hierarchy of the given method (findAnnotation(Method, Class)).

Terminology

The terms directly present, indirectly present, and present have the same meanings as defined in the class-level javadoc for AnnotatedElement (in Java 8).

An annotation is meta-present on an element if the annotation is declared as a meta-annotation on some other annotation which is present on the element. Annotation A is meta-present on another annotation if A is either directly present or meta-present on the other annotation.

Meta-annotation Support

Most find*() methods and some get*() methods in this class provide support for finding annotations used as meta-annotations. Consult the javadoc for each method in this class for details. For fine-grained support for meta-annotations with attribute overrides in composed annotations, consider using AnnotatedElementUtils's more specific methods instead.

Attribute Aliases

All public methods in this class that return annotations, arrays of annotations, or AnnotationAttributes transparently support attribute aliases configured via @AliasFor. Consult the various synthesizeAnnotation*(..) methods for details.

Search Scope

The search algorithms used by methods in this class stop searching for an annotation once the first annotation of the specified type has been found. As a consequence, additional annotations of the specified type will be silently ignored.

从以下版本开始:

2.0

作者:

Rob Harrop, Juergen Hoeller, Sam Brannen, Mark Fisher, Chris Beams, Phillip Webb

另请参阅:

AliasFor, AnnotationAttributes, AnnotatedElementUtils, BridgeMethodResolver, AnnotatedElement.getAnnotations(), AnnotatedElement.getAnnotation(Class), AnnotatedElement.getDeclaredAnnotations()

字段概要

字段

限定符和类型	字段和说明
static String	VALUE The attribute name for annotations with a single element.

构造器概要

构造器

构造器和说明
AnnotationUtils()

方法概要

限定符和类型	方法和说明
(专用程序包) static Object	adaptValue(Object annotatedElement, Object value, boolean classValuesAsString, boolean nestedAnnotationsAsMap) Adapt the given value according to the given class and nested annotation settings.
static void	clearCache() Clear the internal annotation metadata cache.
static <A extends Annotation> A	findAnnotation(AnnotatedElement annotatedElement, Class<A> annotationType) Find a single Annotation of annotationType on the supplied AnnotatedElement.
static <A extends Annotation> A	findAnnotation(Class<?> clazz, Class<A> annotationType) Find a single Annotation of annotationType on the supplied Class, traversing its interfaces, annotations, and superclasses if the annotation is not directly present on the given class itself.
static <A extends Annotation> A	findAnnotation(Method method, Class<A> annotationType) Find a single Annotation of annotationType on the supplied Method, traversing its super methods (i.e., from superclasses and interfaces) if the annotation is not directly present on the given method itself.
static Class<?>	findAnnotationDeclaringClass(Class<? extends Annotation> annotationType, Class<?> clazz) Find the first Class in the inheritance hierarchy of the specified clazz (including the specified clazz itself) on which an annotation of the specified annotationType is directly present.
static Class<?>	findAnnotationDeclaringClassForTypes(List<Class<? extends Annotation>> annotationTypes, Class<?> clazz) Find the first Class in the inheritance hierarchy of the specified clazz (including the specified clazz itself) on which at least one of the specified annotationTypes is directly present.
static <A extends Annotation> A	getAnnotation(AnnotatedElement annotatedElement, Class<A> annotationType) Get a single Annotation of annotationType from the supplied AnnotatedElement, where the annotation is either present or meta-present on the AnnotatedElement.
(专用程序包) static Annotation	getAnnotation(AnnotatedElement element, String annotationName) Get the annotation with the supplied annotationName on the supplied element.
static <A extends Annotation> A	getAnnotation(Annotation annotation, Class<A> annotationType) Get a single Annotation of annotationType from the supplied annotation: either the given annotation itself or a direct meta-annotation thereof.
static <A extends Annotation> A	getAnnotation(Method method, Class<A> annotationType) Get a single Annotation of annotationType from the supplied Method, where the annotation is either present or meta-present on the method.
static AnnotationAttributes	getAnnotationAttributes(AnnotatedElement annotatedElement, Annotation annotation) Retrieve the given annotation's attributes as an AnnotationAttributes map.
static AnnotationAttributes	getAnnotationAttributes(AnnotatedElement annotatedElement, Annotation annotation, boolean classValuesAsString, boolean nestedAnnotationsAsMap) Retrieve the given annotation's attributes as an AnnotationAttributes map.
static Map<String,Object>	getAnnotationAttributes(Annotation annotation) Retrieve the given annotation's attributes as a Map, preserving all attribute types.
static Map<String,Object>	getAnnotationAttributes(Annotation annotation, boolean classValuesAsString) Retrieve the given annotation's attributes as a Map.
static AnnotationAttributes	getAnnotationAttributes(Annotation annotation, boolean classValuesAsString, boolean nestedAnnotationsAsMap) Retrieve the given annotation's attributes as an AnnotationAttributes map.
static Annotation[]	getAnnotations(AnnotatedElement annotatedElement) Get all Annotations that are present on the supplied AnnotatedElement.
static Annotation[]	getAnnotations(Method method) Get all Annotations that are present on the supplied Method.
(专用程序包) static Map<String,List<String>>	getAttributeAliasMap(Class<? extends Annotation> annotationType) Get a map of all attribute aliases declared via @AliasFor in the supplied annotation type.
(专用程序包) static List<String>	getAttributeAliasNames(Method attribute) Get the names of the aliased attributes configured via @AliasFor for the supplied annotation attribute.
(专用程序包) static List<Method>	getAttributeMethods(Class<? extends Annotation> annotationType) Get all methods declared in the supplied annotationType that match Java's requirements for annotation attributes.
(专用程序包) static String	getAttributeOverrideName(Method attribute, Class<? extends Annotation> metaAnnotationType) Get the name of the overridden attribute configured via @AliasFor for the supplied annotation attribute.
static <A extends Annotation> Set<A>	getDeclaredRepeatableAnnotations(AnnotatedElement annotatedElement, Class<A> annotationType) Get the declared repeatable annotations of annotationType from the supplied AnnotatedElement, where such annotations are either directly present, indirectly present, or meta-present on the element.
static <A extends Annotation> Set<A>	getDeclaredRepeatableAnnotations(AnnotatedElement annotatedElement, Class<A> annotationType, Class<? extends Annotation> containerAnnotationType) Get the declared repeatable annotations of annotationType from the supplied AnnotatedElement, where such annotations are either directly present, indirectly present, or meta-present on the element.
static Object	getDefaultValue(Annotation annotation) Retrieve the default value of the value attribute of a single-element Annotation, given an annotation instance.
static Object	getDefaultValue(Annotation annotation, String attributeName) Retrieve the default value of a named attribute, given an annotation instance.
static Object	getDefaultValue(Class<? extends Annotation> annotationType) Retrieve the default value of the value attribute of a single-element Annotation, given the annotation type.
static Object	getDefaultValue(Class<? extends Annotation> annotationType, String attributeName) Retrieve the default value of a named attribute, given the annotation type.
static <A extends Annotation> Set<A>	getRepeatableAnnotation(AnnotatedElement annotatedElement, Class<? extends Annotation> containerAnnotationType, Class<A> annotationType) 已过时。 As of Spring Framework 4.2, use getRepeatableAnnotations() or getDeclaredRepeatableAnnotations() instead.
static <A extends Annotation> Set<A>	getRepeatableAnnotation(Method method, Class<? extends Annotation> containerAnnotationType, Class<A> annotationType) 已过时。 As of Spring Framework 4.2, use getRepeatableAnnotations() or getDeclaredRepeatableAnnotations() instead.
static <A extends Annotation> Set<A>	getRepeatableAnnotations(AnnotatedElement annotatedElement, Class<A> annotationType) Get the repeatable annotations of annotationType from the supplied AnnotatedElement, where such annotations are either present, indirectly present, or meta-present on the element.
static <A extends Annotation> Set<A>	getRepeatableAnnotations(AnnotatedElement annotatedElement, Class<A> annotationType, Class<? extends Annotation> containerAnnotationType) Get the repeatable annotations of annotationType from the supplied AnnotatedElement, where such annotations are either present, indirectly present, or meta-present on the element.
static Object	getValue(Annotation annotation) Retrieve the value of the value attribute of a single-element Annotation, given an annotation instance.
static Object	getValue(Annotation annotation, String attributeName) Retrieve the value of a named attribute, given an annotation instance.
(专用程序包) static void	handleIntrospectionFailure(AnnotatedElement element, Throwable ex) Handle the supplied annotation introspection exception.
static boolean	isAnnotationDeclaredLocally(Class<? extends Annotation> annotationType, Class<?> clazz) Determine whether an annotation of the specified annotationType is declared locally (i.e., directly present) on the supplied clazz.
static boolean	isAnnotationInherited(Class<? extends Annotation> annotationType, Class<?> clazz) Determine whether an annotation of the specified annotationType is present on the supplied clazz and is inherited (i.e., not directly present).
static boolean	isAnnotationMetaPresent(Class<? extends Annotation> annotationType, Class<? extends Annotation> metaAnnotationType) Determine if an annotation of type metaAnnotationType is meta-present on the supplied annotationType.
(专用程序包) static boolean	isAnnotationTypeMethod(Method method) Determine if the supplied method is an "annotationType" method.
(专用程序包) static boolean	isAttributeMethod(Method method) Determine if the supplied method is an annotation attribute method.
static boolean	isInJavaLangAnnotationPackage(Annotation annotation) Determine if the supplied Annotation is defined in the core JDK java.lang.annotation package.
(专用程序包) static boolean	isInJavaLangAnnotationPackage(Class<? extends Annotation> annotationType) Determine if the Annotation with the supplied name is defined in the core JDK java.lang.annotation package.
static boolean	isInJavaLangAnnotationPackage(String annotationType) Determine if the Annotation with the supplied name is defined in the core JDK java.lang.annotation package.
(专用程序包) static boolean	isInterfaceWithAnnotatedMethods(Class<?> ifc)
static void	postProcessAnnotationAttributes(Object annotatedElement, AnnotationAttributes attributes, boolean classValuesAsString) Post-process the supplied AnnotationAttributes, preserving nested annotations as Annotation instances.
(专用程序包) static void	postProcessAnnotationAttributes(Object annotatedElement, AnnotationAttributes attributes, boolean classValuesAsString, boolean nestedAnnotationsAsMap) Post-process the supplied AnnotationAttributes.
static void	registerDefaultValues(AnnotationAttributes attributes) Register the annotation-declared default values for the given attributes, if available.
(专用程序包) static Class<? extends Annotation>	resolveContainerAnnotationType(Class<? extends Annotation> annotationType) Resolve the container type for the supplied repeatable annotationType.
(专用程序包) static void	rethrowAnnotationConfigurationException(Throwable ex) If the supplied throwable is an AnnotationConfigurationException, it will be cast to an AnnotationConfigurationException and thrown, allowing it to propagate to the caller.
(专用程序包) static AnnotationAttributes	retrieveAnnotationAttributes(Object annotatedElement, Annotation annotation, boolean classValuesAsString, boolean nestedAnnotationsAsMap) Retrieve the given annotation's attributes as an AnnotationAttributes map.
(专用程序包) static <A extends Annotation> A	synthesizeAnnotation(A annotation) Synthesize an annotation from the supplied annotation by wrapping it in a dynamic proxy that transparently enforces attribute alias semantics for annotation attributes that are annotated with @AliasFor.
static <A extends Annotation> A	synthesizeAnnotation(A annotation, AnnotatedElement annotatedElement) Synthesize an annotation from the supplied annotation by wrapping it in a dynamic proxy that transparently enforces attribute alias semantics for annotation attributes that are annotated with @AliasFor.
(专用程序包) static <A extends Annotation> A	synthesizeAnnotation(A annotation, Object annotatedElement)
static <A extends Annotation> A	synthesizeAnnotation(Class<A> annotationType) Synthesize an annotation from its default attributes values.
static <A extends Annotation> A	synthesizeAnnotation(Map<String,Object> attributes, Class<A> annotationType, AnnotatedElement annotatedElement) Synthesize an annotation from the supplied map of annotation attributes by wrapping the map in a dynamic proxy that implements an annotation of the specified annotationType and transparently enforces attribute alias semantics for annotation attributes that are annotated with @AliasFor.
(专用程序包) static Annotation[]	synthesizeAnnotationArray(Annotation[] annotations, Object annotatedElement) Synthesize an array of annotations from the supplied array of annotations by creating a new array of the same size and type and populating it with synthesized versions of the annotations from the input array.
(专用程序包) static <A extends Annotation> A[]	synthesizeAnnotationArray(Map<String,Object>[] maps, Class<A> annotationType) Synthesize an array of annotations from the supplied array of maps of annotation attributes by creating a new array of annotationType with the same size and populating it with synthesized versions of the maps from the input array.
static void	validateAnnotation(Annotation annotation) Check the declared attributes of the given annotation, in particular covering Google App Engine's late arrival of TypeNotPresentExceptionProxy for Class values (instead of early Class.getAnnotations() failure.

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

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

字段详细资料

VALUE

public static final String VALUE

The attribute name for annotations with a single element.

另请参阅:

常量字段值

构造器详细资料

AnnotationUtils

public AnnotationUtils()

方法详细资料

getAnnotation

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

Get a single Annotation of annotationType from the supplied annotation: either the given annotation itself or a direct meta-annotation thereof.

Note that this method supports only a single level of meta-annotations. For support for arbitrary levels of meta-annotations, use one of the find*() methods instead.

参数:

annotation - the Annotation to check

annotationType - the annotation type to look for, both locally and as a meta-annotation

返回:

the first matching annotation, or null if not found

从以下版本开始:

4.0

getAnnotation

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

Get a single Annotation of annotationType from the supplied AnnotatedElement, where the annotation is either present or meta-present on the AnnotatedElement.

Note that this method supports only a single level of meta-annotations. For support for arbitrary levels of meta-annotations, use findAnnotation(AnnotatedElement, Class) instead.

参数:

annotatedElement - the AnnotatedElement from which to get the annotation

annotationType - the annotation type to look for, both locally and as a meta-annotation

返回:

the first matching annotation, or null if not found

从以下版本开始:

3.1

getAnnotation

public static <A extends Annotation> A getAnnotation(Method method,
                                                     Class<A> annotationType)

Get a single Annotation of annotationType from the supplied Method, where the annotation is either present or meta-present on the method.

Correctly handles bridge Methods generated by the compiler.

Note that this method supports only a single level of meta-annotations. For support for arbitrary levels of meta-annotations, use findAnnotation(Method, Class) instead.

参数:

method - the method to look for annotations on

annotationType - the annotation type to look for

返回:

the first matching annotation, or null if not found

另请参阅:

org.springframework.core.BridgeMethodResolver#findBridgedMethod(Method), getAnnotation(AnnotatedElement, Class)

getAnnotations

public static Annotation[] getAnnotations(AnnotatedElement annotatedElement)

Get all Annotations that are present on the supplied AnnotatedElement.

Meta-annotations will not be searched.

参数:

annotatedElement - the Method, Constructor or Field to retrieve annotations from

返回:

the annotations found, an empty array, or null if not resolvable (e.g. because nested Class values in annotation attributes failed to resolve at runtime)

从以下版本开始:

4.0.8

另请参阅:

AnnotatedElement.getAnnotations()

getAnnotations

public static Annotation[] getAnnotations(Method method)

Get all Annotations that are present on the supplied Method.

Correctly handles bridge Methods generated by the compiler.

Meta-annotations will not be searched.

参数:

method - the Method to retrieve annotations from

返回:

the annotations found, an empty array, or null if not resolvable (e.g. because nested Class values in annotation attributes failed to resolve at runtime)

另请参阅:

org.springframework.core.BridgeMethodResolver#findBridgedMethod(Method), AnnotatedElement.getAnnotations()

getRepeatableAnnotation

@Deprecated
public static <A extends Annotation> Set<A> getRepeatableAnnotation(Method method,
                                                                                 Class<? extends Annotation> containerAnnotationType,
                                                                                 Class<A> annotationType)

已过时。 As of Spring Framework 4.2, use getRepeatableAnnotations() or getDeclaredRepeatableAnnotations() instead.

Delegates to getRepeatableAnnotations(AnnotatedElement, Class, Class).

从以下版本开始:

4.0

另请参阅:

getRepeatableAnnotations(AnnotatedElement, Class, Class), getDeclaredRepeatableAnnotations(AnnotatedElement, Class, Class)

getRepeatableAnnotation

@Deprecated
public static <A extends Annotation> Set<A> getRepeatableAnnotation(AnnotatedElement annotatedElement,
                                                                                 Class<? extends Annotation> containerAnnotationType,
                                                                                 Class<A> annotationType)

已过时。 As of Spring Framework 4.2, use getRepeatableAnnotations() or getDeclaredRepeatableAnnotations() instead.

Delegates to getRepeatableAnnotations(AnnotatedElement, Class, Class).

从以下版本开始:

4.0

另请参阅:

getRepeatableAnnotations(AnnotatedElement, Class, Class), getDeclaredRepeatableAnnotations(AnnotatedElement, Class, Class)

getRepeatableAnnotations

public static <A extends Annotation> Set<A> getRepeatableAnnotations(AnnotatedElement annotatedElement,
                                                                     Class<A> annotationType)

Get the repeatable annotations of annotationType from the supplied AnnotatedElement, where such annotations are either present, indirectly present, or meta-present on the element.

This method mimics the functionality of Java 8's AnnotatedElement.getAnnotationsByType(Class) with support for automatic detection of a container annotation declared via @Repeatable (when running on Java 8 or higher) and with additional support for meta-annotations.

Handles both single annotations and annotations nested within a container annotation.

Correctly handles bridge methods generated by the compiler if the supplied element is a Method.

Meta-annotations will be searched if the annotation is not present on the supplied element.

参数:

annotatedElement - the element to look for annotations on

annotationType - the annotation type to look for

返回:

the annotations found or an empty set (never null)

从以下版本开始:

4.2

另请参阅:

getRepeatableAnnotations(AnnotatedElement, Class, Class), getDeclaredRepeatableAnnotations(AnnotatedElement, Class, Class), AnnotatedElementUtils#getMergedRepeatableAnnotations(AnnotatedElement, Class), org.springframework.core.BridgeMethodResolver#findBridgedMethod, Repeatable, AnnotatedElement.getAnnotationsByType(java.lang.Class<T>)

getRepeatableAnnotations

public static <A extends Annotation> Set<A> getRepeatableAnnotations(AnnotatedElement annotatedElement,
                                                                     Class<A> annotationType,
                                                                     Class<? extends Annotation> containerAnnotationType)

Get the repeatable annotations of annotationType from the supplied AnnotatedElement, where such annotations are either present, indirectly present, or meta-present on the element.

This method mimics the functionality of Java 8's AnnotatedElement.getAnnotationsByType(Class) with additional support for meta-annotations.

Handles both single annotations and annotations nested within a container annotation.

Correctly handles bridge methods generated by the compiler if the supplied element is a Method.

Meta-annotations will be searched if the annotation is not present on the supplied element.

参数:

annotatedElement - the element to look for annotations on

annotationType - the annotation type to look for

containerAnnotationType - the type of the container that holds the annotations; may be null if a container is not supported or if it should be looked up via @Repeatable when running on Java 8 or higher

返回:

the annotations found or an empty set (never null)

从以下版本开始:

4.2

另请参阅:

getRepeatableAnnotations(AnnotatedElement, Class), getDeclaredRepeatableAnnotations(AnnotatedElement, Class), getDeclaredRepeatableAnnotations(AnnotatedElement, Class, Class), AnnotatedElementUtils#getMergedRepeatableAnnotations(AnnotatedElement, Class, Class), org.springframework.core.BridgeMethodResolver#findBridgedMethod, Repeatable, AnnotatedElement.getAnnotationsByType(java.lang.Class<T>)

getDeclaredRepeatableAnnotations

public static <A extends Annotation> Set<A> getDeclaredRepeatableAnnotations(AnnotatedElement annotatedElement,
                                                                             Class<A> annotationType)

Get the declared repeatable annotations of annotationType from the supplied AnnotatedElement, where such annotations are either directly present, indirectly present, or meta-present on the element.

This method mimics the functionality of Java 8's AnnotatedElement.getDeclaredAnnotationsByType(Class) with support for automatic detection of a container annotation declared via @Repeatable (when running on Java 8 or higher) and with additional support for meta-annotations.

Handles both single annotations and annotations nested within a container annotation.

Correctly handles bridge methods generated by the compiler if the supplied element is a Method.

Meta-annotations will be searched if the annotation is not present on the supplied element.

参数:

annotatedElement - the element to look for annotations on

annotationType - the annotation type to look for

返回:

the annotations found or an empty set (never null)

从以下版本开始:

4.2

另请参阅:

getRepeatableAnnotations(AnnotatedElement, Class), getRepeatableAnnotations(AnnotatedElement, Class, Class), getDeclaredRepeatableAnnotations(AnnotatedElement, Class, Class), AnnotatedElementUtils#getMergedRepeatableAnnotations(AnnotatedElement, Class), org.springframework.core.BridgeMethodResolver#findBridgedMethod, Repeatable, AnnotatedElement.getDeclaredAnnotationsByType(java.lang.Class<T>)

getDeclaredRepeatableAnnotations

public static <A extends Annotation> Set<A> getDeclaredRepeatableAnnotations(AnnotatedElement annotatedElement,
                                                                             Class<A> annotationType,
                                                                             Class<? extends Annotation> containerAnnotationType)

Get the declared repeatable annotations of annotationType from the supplied AnnotatedElement, where such annotations are either directly present, indirectly present, or meta-present on the element.

This method mimics the functionality of Java 8's AnnotatedElement.getDeclaredAnnotationsByType(Class) with additional support for meta-annotations.

Handles both single annotations and annotations nested within a container annotation.

Correctly handles bridge methods generated by the compiler if the supplied element is a Method.

Meta-annotations will be searched if the annotation is not present on the supplied element.

参数:

annotatedElement - the element to look for annotations on

annotationType - the annotation type to look for

containerAnnotationType - the type of the container that holds the annotations; may be null if a container is not supported or if it should be looked up via @Repeatable when running on Java 8 or higher

返回:

the annotations found or an empty set (never null)

从以下版本开始:

4.2

另请参阅:

getRepeatableAnnotations(AnnotatedElement, Class), getRepeatableAnnotations(AnnotatedElement, Class, Class), getDeclaredRepeatableAnnotations(AnnotatedElement, Class), AnnotatedElementUtils#getMergedRepeatableAnnotations(AnnotatedElement, Class, Class), org.springframework.core.BridgeMethodResolver#findBridgedMethod, Repeatable, AnnotatedElement.getDeclaredAnnotationsByType(java.lang.Class<T>)

findAnnotation

public static <A extends Annotation> A findAnnotation(AnnotatedElement annotatedElement,
                                                      Class<A> annotationType)

Find a single Annotation of annotationType on the supplied AnnotatedElement.

Meta-annotations will be searched if the annotation is not directly present on the supplied element.

Warning: this method operates generically on annotated elements. In other words, this method does not execute specialized search algorithms for classes or methods. If you require the more specific semantics of findAnnotation(Class, Class) or findAnnotation(Method, Class), invoke one of those methods instead.

参数:

annotatedElement - the AnnotatedElement on which to find the annotation

annotationType - the annotation type to look for, both locally and as a meta-annotation

返回:

the first matching annotation, or null if not found

从以下版本开始:

4.2

findAnnotation

public static <A extends Annotation> A findAnnotation(Method method,
                                                      Class<A> annotationType)

Find a single Annotation of annotationType on the supplied Method, traversing its super methods (i.e., from superclasses and interfaces) if the annotation is not directly present on the given method itself.

Correctly handles bridge Methods generated by the compiler.

Meta-annotations will be searched if the annotation is not directly present on the method.

Annotations on methods are not inherited by default, so we need to handle this explicitly.

参数:

method - the method to look for annotations on

annotationType - the annotation type to look for

返回:

the first matching annotation, or null if not found

另请参阅:

getAnnotation(Method, Class)

isInterfaceWithAnnotatedMethods

static boolean isInterfaceWithAnnotatedMethods(Class<?> ifc)

findAnnotation

public static <A extends Annotation> A findAnnotation(Class<?> clazz,
                                                      Class<A> annotationType)

Find a single Annotation of annotationType on the supplied Class, traversing its interfaces, annotations, and superclasses if the annotation is not directly present on the given class itself.

This method explicitly handles class-level annotations which are not declared as inherited as well as meta-annotations and annotations on interfaces.

The algorithm operates as follows:

1. Search for the annotation on the given class and return it if found.
2. Recursively search through all annotations that the given class declares.
3. Recursively search through all interfaces that the given class declares.
4. Recursively search through the superclass hierarchy of the given class.

Note: in this context, the term recursively means that the search process continues by returning to step #1 with the current interface, annotation, or superclass as the class to look for annotations on.

参数:

clazz - the class to look for annotations on

annotationType - the type of annotation to look for

返回:

the first matching annotation, or null if not found

findAnnotationDeclaringClass

public static Class<?> findAnnotationDeclaringClass(Class<? extends Annotation> annotationType,
                                                    Class<?> clazz)

Find the first Class in the inheritance hierarchy of the specified clazz (including the specified clazz itself) on which an annotation of the specified annotationType is directly present.

If the supplied clazz is an interface, only the interface itself will be checked; the inheritance hierarchy for interfaces will not be traversed.

Meta-annotations will not be searched.

The standard Class API does not provide a mechanism for determining which class in an inheritance hierarchy actually declares an Annotation, so we need to handle this explicitly.

参数:

annotationType - the annotation type to look for

clazz - the class to check for the annotation on (may be null)

返回:

the first Class in the inheritance hierarchy that declares an annotation of the specified annotationType, or null if not found

另请参阅:

Class.isAnnotationPresent(Class), Class.getDeclaredAnnotations(), findAnnotationDeclaringClassForTypes(List, Class), isAnnotationDeclaredLocally(Class, Class)

findAnnotationDeclaringClassForTypes

public static Class<?> findAnnotationDeclaringClassForTypes(List<Class<? extends Annotation>> annotationTypes,
                                                            Class<?> clazz)

Find the first Class in the inheritance hierarchy of the specified clazz (including the specified clazz itself) on which at least one of the specified annotationTypes is directly present.

If the supplied clazz is an interface, only the interface itself will be checked; the inheritance hierarchy for interfaces will not be traversed.

Meta-annotations will not be searched.

The standard Class API does not provide a mechanism for determining which class in an inheritance hierarchy actually declares one of several candidate annotations, so we need to handle this explicitly.

参数:

annotationTypes - the annotation types to look for

clazz - the class to check for the annotations on, or null

返回:

the first Class in the inheritance hierarchy that declares an annotation of at least one of the specified annotationTypes, or null if not found

从以下版本开始:

3.2.2

另请参阅:

Class.isAnnotationPresent(Class), Class.getDeclaredAnnotations(), findAnnotationDeclaringClass(Class, Class), isAnnotationDeclaredLocally(Class, Class)

isAnnotationDeclaredLocally

public static boolean isAnnotationDeclaredLocally(Class<? extends Annotation> annotationType,
                                                  Class<?> clazz)

Determine whether an annotation of the specified annotationType is declared locally (i.e., directly present) on the supplied clazz.

The supplied Class may represent any type.

Meta-annotations will not be searched.

Note: This method does not determine if the annotation is inherited. For greater clarity regarding inherited annotations, consider using isAnnotationInherited(Class, Class) instead.

参数:

annotationType - the annotation type to look for

clazz - the class to check for the annotation on

返回:

true if an annotation of the specified annotationType is directly present

另请参阅:

Class.getDeclaredAnnotations(), Class.getDeclaredAnnotation(Class), isAnnotationInherited(Class, Class)

isAnnotationInherited

public static boolean isAnnotationInherited(Class<? extends Annotation> annotationType,
                                            Class<?> clazz)

Determine whether an annotation of the specified annotationType is present on the supplied clazz and is inherited (i.e., not directly present).

Meta-annotations will not be searched.

If the supplied clazz is an interface, only the interface itself will be checked. In accordance with standard meta-annotation semantics in Java, the inheritance hierarchy for interfaces will not be traversed. See the javadoc for the @Inherited meta-annotation for further details regarding annotation inheritance.

参数:

annotationType - the annotation type to look for

clazz - the class to check for the annotation on

返回:

true if an annotation of the specified annotationType is present and inherited

另请参阅:

Class.isAnnotationPresent(Class), isAnnotationDeclaredLocally(Class, Class)

isAnnotationMetaPresent

public static boolean isAnnotationMetaPresent(Class<? extends Annotation> annotationType,
                                              Class<? extends Annotation> metaAnnotationType)

Determine if an annotation of type metaAnnotationType is meta-present on the supplied annotationType.

参数:

annotationType - the annotation type to search on

metaAnnotationType - the type of meta-annotation to search for

返回:

true if such an annotation is meta-present

从以下版本开始:

4.2.1

isInJavaLangAnnotationPackage

public static boolean isInJavaLangAnnotationPackage(Annotation annotation)

Determine if the supplied Annotation is defined in the core JDK java.lang.annotation package.

参数:

annotation - the annotation to check

返回:

true if the annotation is in the java.lang.annotation package

isInJavaLangAnnotationPackage

static boolean isInJavaLangAnnotationPackage(Class<? extends Annotation> annotationType)

Determine if the Annotation with the supplied name is defined in the core JDK java.lang.annotation package.

参数:

annotationType - the annotation type to check

返回:

true if the annotation is in the java.lang.annotation package

从以下版本开始:

4.3.8

isInJavaLangAnnotationPackage

public static boolean isInJavaLangAnnotationPackage(String annotationType)

Determine if the Annotation with the supplied name is defined in the core JDK java.lang.annotation package.

参数:

annotationType - the name of the annotation type to check

返回:

true if the annotation is in the java.lang.annotation package

从以下版本开始:

4.2

validateAnnotation

public static void validateAnnotation(Annotation annotation)

Check the declared attributes of the given annotation, in particular covering Google App Engine's late arrival of TypeNotPresentExceptionProxy for Class values (instead of early Class.getAnnotations() failure.

This method not failing indicates that getAnnotationAttributes(Annotation) won't failure either (when attempted later on).

参数:

annotation - the annotation to validate

抛出:

IllegalStateException - if a declared Class attribute could not be read

从以下版本开始:

4.3.15

另请参阅:

Class.getAnnotations(), getAnnotationAttributes(Annotation)

getAnnotationAttributes

public static Map<String,Object> getAnnotationAttributes(Annotation annotation)

Retrieve the given annotation's attributes as a Map, preserving all attribute types.

Equivalent to calling getAnnotationAttributes(Annotation, boolean, boolean) with the classValuesAsString and nestedAnnotationsAsMap parameters set to false.

Note: This method actually returns an AnnotationAttributes instance. However, the Map signature has been preserved for binary compatibility.

参数:

annotation - the annotation to retrieve the attributes for

返回:

the Map of annotation attributes, with attribute names as keys and corresponding attribute values as values (never null)

另请参阅:

getAnnotationAttributes(AnnotatedElement, Annotation), getAnnotationAttributes(Annotation, boolean, boolean), getAnnotationAttributes(AnnotatedElement, Annotation, boolean, boolean)

getAnnotationAttributes

public static Map<String,Object> getAnnotationAttributes(Annotation annotation,
                                                         boolean classValuesAsString)

Retrieve the given annotation's attributes as a Map.

Equivalent to calling getAnnotationAttributes(Annotation, boolean, boolean) with the nestedAnnotationsAsMap parameter set to false.

Note: This method actually returns an AnnotationAttributes instance. However, the Map signature has been preserved for binary compatibility.

参数:

annotation - the annotation to retrieve the attributes for

classValuesAsString - whether to convert Class references into Strings (for compatibility with org.springframework.core.type.AnnotationMetadata) or to preserve them as Class references

返回:

the Map of annotation attributes, with attribute names as keys and corresponding attribute values as values (never null)

另请参阅:

getAnnotationAttributes(Annotation, boolean, boolean)

getAnnotationAttributes

public static AnnotationAttributes getAnnotationAttributes(Annotation annotation,
                                                           boolean classValuesAsString,
                                                           boolean nestedAnnotationsAsMap)

Retrieve the given annotation's attributes as an AnnotationAttributes map.

This method provides fully recursive annotation reading capabilities on par with the reflection-based org.springframework.core.type.StandardAnnotationMetadata.

参数:

annotation - the annotation to retrieve the attributes for

classValuesAsString - whether to convert Class references into Strings (for compatibility with org.springframework.core.type.AnnotationMetadata) or to preserve them as Class references

nestedAnnotationsAsMap - whether to convert nested annotations into AnnotationAttributes maps (for compatibility with org.springframework.core.type.AnnotationMetadata) or to preserve them as Annotation instances

返回:

the annotation attributes (a specialized Map) with attribute names as keys and corresponding attribute values as values (never null)

从以下版本开始:

3.1.1

getAnnotationAttributes

public static AnnotationAttributes getAnnotationAttributes(AnnotatedElement annotatedElement,
                                                           Annotation annotation)

Retrieve the given annotation's attributes as an AnnotationAttributes map.

Equivalent to calling getAnnotationAttributes(AnnotatedElement, Annotation, boolean, boolean) with the classValuesAsString and nestedAnnotationsAsMap parameters set to false.

参数:

annotatedElement - the element that is annotated with the supplied annotation; may be null if unknown

annotation - the annotation to retrieve the attributes for

返回:

the annotation attributes (a specialized Map) with attribute names as keys and corresponding attribute values as values (never null)

从以下版本开始:

4.2

另请参阅:

getAnnotationAttributes(AnnotatedElement, Annotation, boolean, boolean)

getAnnotationAttributes

public static AnnotationAttributes getAnnotationAttributes(AnnotatedElement annotatedElement,
                                                           Annotation annotation,
                                                           boolean classValuesAsString,
                                                           boolean nestedAnnotationsAsMap)

Retrieve the given annotation's attributes as an AnnotationAttributes map.

This method provides fully recursive annotation reading capabilities on par with the reflection-based org.springframework.core.type.StandardAnnotationMetadata.

参数:

annotatedElement - the element that is annotated with the supplied annotation; may be null if unknown

annotation - the annotation to retrieve the attributes for

classValuesAsString - whether to convert Class references into Strings (for compatibility with org.springframework.core.type.AnnotationMetadata) or to preserve them as Class references

nestedAnnotationsAsMap - whether to convert nested annotations into AnnotationAttributes maps (for compatibility with org.springframework.core.type.AnnotationMetadata) or to preserve them as Annotation instances

返回:

the annotation attributes (a specialized Map) with attribute names as keys and corresponding attribute values as values (never null)

从以下版本开始:

4.2

retrieveAnnotationAttributes

static AnnotationAttributes retrieveAnnotationAttributes(Object annotatedElement,
                                                         Annotation annotation,
                                                         boolean classValuesAsString,
                                                         boolean nestedAnnotationsAsMap)

Retrieve the given annotation's attributes as an AnnotationAttributes map.

This method provides fully recursive annotation reading capabilities on par with the reflection-based org.springframework.core.type.StandardAnnotationMetadata.

NOTE: This variant of getAnnotationAttributes() is only intended for use within the framework. The following special rules apply:

1. Default values will be replaced with default value placeholders.
2. The resulting, merged annotation attributes should eventually be post-processed in order to ensure that placeholders have been replaced by actual default values and in order to enforce @AliasFor semantics.

参数:

annotatedElement - the element that is annotated with the supplied annotation; may be null if unknown

annotation - the annotation to retrieve the attributes for

classValuesAsString - whether to convert Class references into Strings (for compatibility with org.springframework.core.type.AnnotationMetadata) or to preserve them as Class references

nestedAnnotationsAsMap - whether to convert nested annotations into AnnotationAttributes maps (for compatibility with org.springframework.core.type.AnnotationMetadata) or to preserve them as Annotation instances

返回:

the annotation attributes (a specialized Map) with attribute names as keys and corresponding attribute values as values (never null)

从以下版本开始:

4.2

另请参阅:

postProcessAnnotationAttributes(java.lang.Object, cn.sexycode.util.core.cls.AnnotationAttributes, boolean)

adaptValue

static Object adaptValue(Object annotatedElement,
                         Object value,
                         boolean classValuesAsString,
                         boolean nestedAnnotationsAsMap)

Adapt the given value according to the given class and nested annotation settings.

Nested annotations will be synthesized.

参数:

annotatedElement - the element that is annotated, used for contextual logging; may be null if unknown

value - the annotation attribute value

classValuesAsString - whether to convert Class references into Strings (for compatibility with org.springframework.core.type.AnnotationMetadata) or to preserve them as Class references

nestedAnnotationsAsMap - whether to convert nested annotations into AnnotationAttributes maps (for compatibility with org.springframework.core.type.AnnotationMetadata) or to preserve them as Annotation instances

返回:

the adapted value, or the original value if no adaptation is needed

registerDefaultValues

public static void registerDefaultValues(AnnotationAttributes attributes)

Register the annotation-declared default values for the given attributes, if available.

参数:

attributes - the annotation attributes to process

从以下版本开始:

4.3.2

postProcessAnnotationAttributes

public static void postProcessAnnotationAttributes(Object annotatedElement,
                                                   AnnotationAttributes attributes,
                                                   boolean classValuesAsString)

Post-process the supplied AnnotationAttributes, preserving nested annotations as Annotation instances.

Specifically, this method enforces attribute alias semantics for annotation attributes that are annotated with @AliasFor and replaces default value placeholders with their original default values.

参数:

annotatedElement - the element that is annotated with an annotation or annotation hierarchy from which the supplied attributes were created; may be null if unknown

attributes - the annotation attributes to post-process

classValuesAsString - whether to convert Class references into Strings (for compatibility with org.springframework.core.type.AnnotationMetadata) or to preserve them as Class references

从以下版本开始:

4.3.2

另请参阅:

postProcessAnnotationAttributes(Object, AnnotationAttributes, boolean, boolean), getDefaultValue(Class, String)

postProcessAnnotationAttributes

static void postProcessAnnotationAttributes(Object annotatedElement,
                                            AnnotationAttributes attributes,
                                            boolean classValuesAsString,
                                            boolean nestedAnnotationsAsMap)

Post-process the supplied AnnotationAttributes.

Specifically, this method enforces attribute alias semantics for annotation attributes that are annotated with @AliasFor and replaces default value placeholders with their original default values.

参数:

annotatedElement - the element that is annotated with an annotation or annotation hierarchy from which the supplied attributes were created; may be null if unknown

attributes - the annotation attributes to post-process

classValuesAsString - whether to convert Class references into Strings (for compatibility with org.springframework.core.type.AnnotationMetadata) or to preserve them as Class references

nestedAnnotationsAsMap - whether to convert nested annotations into AnnotationAttributes maps (for compatibility with org.springframework.core.type.AnnotationMetadata) or to preserve them as Annotation instances

从以下版本开始:

4.2

另请参阅:

retrieveAnnotationAttributes(Object, Annotation, boolean, boolean), getDefaultValue(Class, String)

getValue

public static Object getValue(Annotation annotation)

Retrieve the value of the value attribute of a single-element Annotation, given an annotation instance.

参数:

annotation - the annotation instance from which to retrieve the value

返回:

the attribute value, or null if not found unless the attribute value cannot be retrieved due to an AnnotationConfigurationException, in which case such an exception will be rethrown

另请参阅:

getValue(Annotation, String)

getValue

public static Object getValue(Annotation annotation,
                              String attributeName)

Retrieve the value of a named attribute, given an annotation instance.

参数:

annotation - the annotation instance from which to retrieve the value

attributeName - the name of the attribute value to retrieve

返回:

the attribute value, or null if not found unless the attribute value cannot be retrieved due to an AnnotationConfigurationException, in which case such an exception will be rethrown

另请参阅:

getValue(Annotation), rethrowAnnotationConfigurationException(Throwable)

getDefaultValue

public static Object getDefaultValue(Annotation annotation)

Retrieve the default value of the value attribute of a single-element Annotation, given an annotation instance.

参数:

annotation - the annotation instance from which to retrieve the default value

返回:

the default value, or null if not found

另请参阅:

getDefaultValue(Annotation, String)

getDefaultValue

public static Object getDefaultValue(Annotation annotation,
                                     String attributeName)

Retrieve the default value of a named attribute, given an annotation instance.

参数:

annotation - the annotation instance from which to retrieve the default value

attributeName - the name of the attribute value to retrieve

返回:

the default value of the named attribute, or null if not found

另请参阅:

getDefaultValue(Class, String)

getDefaultValue

public static Object getDefaultValue(Class<? extends Annotation> annotationType)

Retrieve the default value of the value attribute of a single-element Annotation, given the annotation type.

参数:

annotationType - the annotation type for which the default value should be retrieved

返回:

the default value, or null if not found

另请参阅:

getDefaultValue(Class, String)

getDefaultValue

public static Object getDefaultValue(Class<? extends Annotation> annotationType,
                                     String attributeName)

Retrieve the default value of a named attribute, given the annotation type.

参数:

annotationType - the annotation type for which the default value should be retrieved

attributeName - the name of the attribute value to retrieve.

返回:

the default value of the named attribute, or null if not found

另请参阅:

getDefaultValue(Annotation, String)

synthesizeAnnotation

static <A extends Annotation> A synthesizeAnnotation(A annotation)

Synthesize an annotation from the supplied annotation by wrapping it in a dynamic proxy that transparently enforces attribute alias semantics for annotation attributes that are annotated with @AliasFor.

参数:

annotation - the annotation to synthesize

返回:

the synthesized annotation, if the supplied annotation is synthesizable; null if the supplied annotation is null; otherwise, the supplied annotation unmodified

抛出:

AnnotationConfigurationException - if invalid configuration of @AliasFor is detected

从以下版本开始:

4.2

另请参阅:

synthesizeAnnotation(Annotation, AnnotatedElement)

synthesizeAnnotation

public static <A extends Annotation> A synthesizeAnnotation(A annotation,
                                                            AnnotatedElement annotatedElement)

Synthesize an annotation from the supplied annotation by wrapping it in a dynamic proxy that transparently enforces attribute alias semantics for annotation attributes that are annotated with @AliasFor.

参数:

annotation - the annotation to synthesize

annotatedElement - the element that is annotated with the supplied annotation; may be null if unknown

返回:

the synthesized annotation if the supplied annotation is synthesizable; null if the supplied annotation is null; otherwise the supplied annotation unmodified

抛出:

AnnotationConfigurationException - if invalid configuration of @AliasFor is detected

从以下版本开始:

4.2

另请参阅:

synthesizeAnnotation(Map, Class, AnnotatedElement), synthesizeAnnotation(Class)

synthesizeAnnotation

static <A extends Annotation> A synthesizeAnnotation(A annotation,
                                                     Object annotatedElement)

synthesizeAnnotation

public static <A extends Annotation> A synthesizeAnnotation(Map<String,Object> attributes,
                                                            Class<A> annotationType,
                                                            AnnotatedElement annotatedElement)

Synthesize an annotation from the supplied map of annotation attributes by wrapping the map in a dynamic proxy that implements an annotation of the specified annotationType and transparently enforces attribute alias semantics for annotation attributes that are annotated with @AliasFor.

The supplied map must contain a key-value pair for every attribute defined in the supplied annotationType that is not aliased or does not have a default value. Nested maps and nested arrays of maps will be recursively synthesized into nested annotations or nested arrays of annotations, respectively.

Note that AnnotationAttributes is a specialized type of Map that is an ideal candidate for this method's attributes argument.

参数:

attributes - the map of annotation attributes to synthesize

annotationType - the type of annotation to synthesize

annotatedElement - the element that is annotated with the annotation corresponding to the supplied attributes; may be null if unknown

返回:

the synthesized annotation, or null if the supplied attributes map is null

抛出:

IllegalArgumentException - if a required attribute is missing or if an attribute is not of the correct type

AnnotationConfigurationException - if invalid configuration of @AliasFor is detected

从以下版本开始:

4.2

另请参阅:

synthesizeAnnotation(Annotation, AnnotatedElement), synthesizeAnnotation(Class), getAnnotationAttributes(AnnotatedElement, Annotation), getAnnotationAttributes(AnnotatedElement, Annotation, boolean, boolean)

synthesizeAnnotation

public static <A extends Annotation> A synthesizeAnnotation(Class<A> annotationType)

Synthesize an annotation from its default attributes values.

This method simply delegates to synthesizeAnnotation(Map, Class, AnnotatedElement), supplying an empty map for the source attribute values and null for the AnnotatedElement.

参数:

annotationType - the type of annotation to synthesize

返回:

the synthesized annotation

抛出:

IllegalArgumentException - if a required attribute is missing

AnnotationConfigurationException - if invalid configuration of @AliasFor is detected

从以下版本开始:

4.2

另请参阅:

synthesizeAnnotation(Map, Class, AnnotatedElement), synthesizeAnnotation(Annotation, AnnotatedElement)

synthesizeAnnotationArray

static Annotation[] synthesizeAnnotationArray(Annotation[] annotations,
                                              Object annotatedElement)

Synthesize an array of annotations from the supplied array of annotations by creating a new array of the same size and type and populating it with synthesized versions of the annotations from the input array.

参数:

annotations - the array of annotations to synthesize

annotatedElement - the element that is annotated with the supplied array of annotations; may be null if unknown

返回:

a new array of synthesized annotations, or null if the supplied array is null

抛出:

AnnotationConfigurationException - if invalid configuration of @AliasFor is detected

从以下版本开始:

4.2

另请参阅:

synthesizeAnnotation(Annotation, AnnotatedElement), synthesizeAnnotation(Map, Class, AnnotatedElement)

synthesizeAnnotationArray

static <A extends Annotation> A[] synthesizeAnnotationArray(Map<String,Object>[] maps,
                                                            Class<A> annotationType)

Synthesize an array of annotations from the supplied array of maps of annotation attributes by creating a new array of annotationType with the same size and populating it with synthesized versions of the maps from the input array.

参数:

maps - the array of maps of annotation attributes to synthesize

annotationType - the type of annotations to synthesize (never null)

返回:

a new array of synthesized annotations, or null if the supplied array is null

抛出:

AnnotationConfigurationException - if invalid configuration of @AliasFor is detected

从以下版本开始:

4.2.1

另请参阅:

synthesizeAnnotation(Map, Class, AnnotatedElement), synthesizeAnnotationArray(Annotation[], Object)

getAttributeAliasMap

static Map<String,List<String>> getAttributeAliasMap(Class<? extends Annotation> annotationType)

Get a map of all attribute aliases declared via @AliasFor in the supplied annotation type.

The map is keyed by attribute name with each value representing a list of names of aliased attributes.

For explicit alias pairs such as x and y (i.e., where x is an @AliasFor("y") and y is an @AliasFor("x"), there will be two entries in the map: x -> (y) and y -> (x).

For implicit aliases (i.e., attributes that are declared as attribute overrides for the same attribute in the same meta-annotation), there will be n entries in the map. For example, if x, y, and z are implicit aliases, the map will contain the following entries: x -> (y, z), y -> (x, z), z -> (x, y).

An empty return value implies that the annotation does not declare any attribute aliases.

参数:

annotationType - the annotation type to find attribute aliases in

返回:

a map containing attribute aliases (never null)

从以下版本开始:

4.2

getAttributeAliasNames

static List<String> getAttributeAliasNames(Method attribute)

Get the names of the aliased attributes configured via @AliasFor for the supplied annotation attribute.

参数:

attribute - the attribute to find aliases for

返回:

the names of the aliased attributes (never null, though potentially empty)

抛出:

IllegalArgumentException - if the supplied attribute method is null or not from an annotation

AnnotationConfigurationException - if invalid configuration of @AliasFor is detected

从以下版本开始:

4.2

另请参阅:

getAttributeOverrideName(Method, Class)

getAttributeOverrideName

static String getAttributeOverrideName(Method attribute,
                                       Class<? extends Annotation> metaAnnotationType)

Get the name of the overridden attribute configured via @AliasFor for the supplied annotation attribute.

参数:

attribute - the attribute from which to retrieve the override (never null)

metaAnnotationType - the type of meta-annotation in which the overridden attribute is allowed to be declared

返回:

the name of the overridden attribute, or null if not found or not applicable for the specified meta-annotation type

抛出:

IllegalArgumentException - if the supplied attribute method is null or not from an annotation, or if the supplied meta-annotation type is null or Annotation

AnnotationConfigurationException - if invalid configuration of @AliasFor is detected

从以下版本开始:

4.2

getAttributeMethods

static List<Method> getAttributeMethods(Class<? extends Annotation> annotationType)

Get all methods declared in the supplied annotationType that match Java's requirements for annotation attributes.

All methods in the returned list will be made accessible.

参数:

annotationType - the type in which to search for attribute methods (never null)

返回:

all annotation attribute methods in the specified annotation type (never null, though potentially empty)

从以下版本开始:

4.2

getAnnotation

static Annotation getAnnotation(AnnotatedElement element,
                                String annotationName)

Get the annotation with the supplied annotationName on the supplied element.

参数:

element - the element to search on

annotationName - the fully qualified class name of the annotation type to find

返回:

the annotation if found; null otherwise

从以下版本开始:

4.2

isAttributeMethod

static boolean isAttributeMethod(Method method)

Determine if the supplied method is an annotation attribute method.

参数:

method - the method to check

返回:

true if the method is an attribute method

从以下版本开始:

4.2

isAnnotationTypeMethod

static boolean isAnnotationTypeMethod(Method method)

Determine if the supplied method is an "annotationType" method.

返回:

true if the method is an "annotationType" method

从以下版本开始:

4.2

另请参阅:

Annotation.annotationType()

resolveContainerAnnotationType

static Class<? extends Annotation> resolveContainerAnnotationType(Class<? extends Annotation> annotationType)

Resolve the container type for the supplied repeatable annotationType.

Automatically detects a container annotation declared via Repeatable. If the supplied annotation type is not annotated with @Repeatable, this method simply returns null.

从以下版本开始:

4.2

rethrowAnnotationConfigurationException

static void rethrowAnnotationConfigurationException(Throwable ex)

If the supplied throwable is an AnnotationConfigurationException, it will be cast to an AnnotationConfigurationException and thrown, allowing it to propagate to the caller.

Otherwise, this method does nothing.

参数:

ex - the throwable to inspect

从以下版本开始:

4.2

handleIntrospectionFailure

static void handleIntrospectionFailure(AnnotatedElement element,
                                       Throwable ex)

Handle the supplied annotation introspection exception.

If the supplied exception is an AnnotationConfigurationException, it will simply be thrown, allowing it to propagate to the caller, and nothing will be logged.

Otherwise, this method logs an introspection failure (in particular TypeNotPresentExceptions) before moving on, assuming nested Class values were not resolvable within annotation attributes and thereby effectively pretending there were no annotations on the specified element.

参数:

element - the element that we tried to introspect annotations on

ex - the exception that we encountered

另请参阅:

rethrowAnnotationConfigurationException(java.lang.Throwable)

clearCache

public static void clearCache()

Clear the internal annotation metadata cache.

从以下版本开始:

4.3.15