compact3

javax.lang.model

Interface AnnotatedConstruct

All Known Subinterfaces:

ArrayType ， DeclaredType ， Element ， ErrorType ， ExecutableElement ， ExecutableType ， IntersectionType ， NoType ， NullType ， PackageElement ， Parameterizable ， PrimitiveType ， QualifiedNameable ， ReferenceType ， TypeElement ， TypeMirror ， TypeParameterElement ， TypeVariable ， UnionType ， VariableElement ， WildcardType

public interface AnnotatedConstruct

表示可以注释的构造。 一个构造是element或type 。 元素上的注释位于声明上 ，而类型上的注释是特定用途的类型名称。 直接呈现 ， 呈现 ， 间接呈现和关联的术语在整个界面中被使用以精确描述本文定义的方法返回哪些注释。

在下面的定义中，注释A具有注释类型AT 。 如果AT是可重复的注释类型，则包含注释的类型是ATC 。

注释A 直接存在于构造C上：

• A被明确或隐含地声明为适用于C的源代码表示。

  通常，如果类型AT的一个注释出现在C表示的源代码中，则A被明确声明为适用于C。 如果在C上存在多个类型AT的注释，则如果AT是可重复的注释类型，则在C上隐式声明类型ATC的注释。

• A的表示显示在对C可执行输出，如RuntimeVisibleAnnotations或RuntimeVisibleParameterAnnotations一个类文件的属性。

注释A 存在于构造C上：

• A直接出现在C上 。
• 类型的AT没有注释是直接存在于C，以及C是一类和AT是可继承和A为存在于C的超类。

注释A 间接存在于构造C上：

• AT是具有包含注释类型ATC的可重复注释类型。
• 类型ATC的注释直接出现在C上 ， A是包含在调用ATC直接注释的value方法的结果中的value 。

注释A与构建体C如果任一相关联的 ：

• A直接或间接出现在C上 。
• 类型的AT没有注释是直接或间接地存在于C，以及C是一类，和AT是可继承，和A与C的超类相关联。

从以下版本开始：

1.8

See The Java™ Language Specification:

9.6注释类型，9.6.3.3 @继承

方法摘要

Modifier and Type	Method and Description
<A extends Annotation> A	getAnnotation(类<A> annotationType) 返回指定类型的这种构造的注解，如果这样的注释 存在 ，否则 null 。
List<? extends AnnotationMirror>	getAnnotationMirrors() 返回 直接存在于此构造上的注释。
<A extends Annotation> A[]	getAnnotationsByType(类<A> annotationType) 返回与此 相关的结构注解。

方法详细信息

getAnnotationMirrors

List<? extends AnnotationMirror> getAnnotationMirrors()

返回 直接存在于此构造上的注释。

结果

该结构上直接出现的注释; 一个空列表，如果没有

getAnnotation

<A extends Annotation> A getAnnotation(类<A> annotationType)

返回指定类型的这种构造的注解，如果这样的注释存在 ，否则null 。

此方法返回的注释可能包含一个值为类 。 此值无法直接返回：查找和加载类（例如要使用的类加载器）所需的信息不可用，并且该类可能无法加载。 试图读取一类通过调用返回的注释相关的方法将导致对象MirroredTypeException ，从该对应的TypeMirror可以被提取。 类似地，尝试读取一个Class[]元素将导致一个MirroredTypesException 。

Note: This method is unlike others in this and related interfaces. It operates on runtime reflective information — representations of annotation types currently loaded into the VM — rather than on the representations defined by and used throughout these interfaces. Consequently, calling methods on the returned annotation object can throw many of the exceptions that can be thrown when calling methods on an annotation object returned by core reflection. This method is intended for callers that are written to operate on a known, fixed set of annotation types.

参数类型

A - 注释类型

参数

annotationType - 对应于注释类型的 类对象

结果

此构造的注释指定的注释类型（如果存在），否则为 null

另请参见：

getAnnotationMirrors() ， AnnotatedElement.getAnnotation(java.lang.Class<T>) ， EnumConstantNotPresentException ， AnnotationTypeMismatchException ， IncompleteAnnotationException ， MirroredTypeException ， MirroredTypesException

See The Java™ Language Specification:

9.6.1注释类型元素

getAnnotationsByType

<A extends Annotation> A[] getAnnotationsByType(类<A> annotationType)

返回与此相关的结构注解。 如果没有用该构建体相关联的注释，返回值是长度为0注解，它们可直接或间接地存在于构建体C被计算为，如果第C间接本注释直接存在第C代替的顺序的阵列的容器注释的顺序，它们在容器注释的值元素中显示的顺序。 该方法与getAnnotation(Class)之间的区别在于，该方法检测其参数是否是可重复的注释类型 ，如果是，则尝试通过“查看”容器注释来查找该类型的一个或多个注释。

此方法返回的注释可能包含一个值为类 。 此值无法直接返回：查找和加载类（例如要使用的类加载器）所需的信息不可用，并且该类可能无法加载。 试图读取一类通过调用返回的注释相关的方法将导致对象MirroredTypeException ，从该对应的TypeMirror可以被提取。 类似地，尝试读取一个Class[]值将导致一个MirroredTypesException 。

Note: This method is unlike others in this and related interfaces. It operates on runtime reflective information — representations of annotation types currently loaded into the VM — rather than on the representations defined by and used throughout these interfaces. Consequently, calling methods on the returned annotation object can throw many of the exceptions that can be thrown when calling methods on an annotation object returned by core reflection. This method is intended for callers that are written to operate on a known, fixed set of annotation types.

参数类型

A - 注释类型

参数

annotationType - 对应于注释类型的 类对象

结果

这个构造体对于指定的注释类型的注释，如果存在于此构造上，否则为空数组

另请参见：

getAnnotationMirrors() ， getAnnotation(Class) ， AnnotatedElement.getAnnotationsByType(Class) ， EnumConstantNotPresentException ， AnnotationTypeMismatchException ， IncompleteAnnotationException ， MirroredTypeException ， MirroredTypesException

See The Java™ Language Specification:

9.6注释类型，9.6.1注释类型元素