compact3

javax.lang.model.element

Interface Element

All Superinterfaces:

AnnotatedConstruct

All Known Subinterfaces:

ExecutableElement ， PackageElement ， Parameterizable ， QualifiedNameable ， TypeElement ， TypeParameterElement ， VariableElement

public interface Element
extends AnnotatedConstruct

表示程序元素，如程序包，类或方法。 每个元素表示静态的语言级结构（而不是虚拟机的运行时结构）。

应使用equals(Object)方法比较元素。 不能保证任何特定元素始终由同一个对象表示。

要实现基于Element对象类的操作，请使用visitor或使用getKind()方法的结果。 使用instanceof 不一定是确定有效类的对象在这个造型层次，因为一个实现可以选择让单个对象实现多个可靠的成语Element子接口。

从以下版本开始：

1.6

另请参见：

Elements ， TypeMirror

方法摘要

Modifier and Type	Method and Description
<R,P> R	accept(ElementVisitor<R,P> v, P p) 将访问者应用于此元素。
TypeMirror	asType() 返回此元素定义的类型。
boolean	equals(Object obj) 返回 true如果参数表示相同的元件如 this ，或 false否则。
<A extends Annotation> A	getAnnotation(类<A> annotationType) 返回指定类型的这种构造的注解，如果这样的注释 存在 ，否则 null 。
List<? extends AnnotationMirror>	getAnnotationMirrors() 返回 直接存在于此构造上的注释。
List<? extends Element>	getEnclosedElements() 返回由这个元素直接包围的松散元素。
Element	getEnclosingElement() 返回这个元素所在的最内层元素。
ElementKind	getKind() 返回此元素的 kind 。
Set<Modifier>	getModifiers() 返回此元素的修饰符，不包括注释。
Name	getSimpleName() 返回此元素的简单（不合格）名称。
int	hashCode() 服从的总承包 Object.hashCode 。

Methods inherited from interface javax.lang.model.AnnotatedConstruct

getAnnotationsByType

方法详细信息

asType

TypeMirror asType()

返回此元素定义的类型。

通用元素定义了一系列类型，而不仅仅是一个类型。 如果这是一个通用元素，则返回原型类型。 这是元素对与其自己的形式类型参数相对应的类型变量的调用。 例如，对于通用类元素C<N extends Number> ，返回参数化类型C<N> 。 Types实用程序界面具有更多的一般方法来获取由元素定义的全部类型。

结果

该元素定义的类型

另请参见：

Types

getKind

ElementKind getKind()

返回此元素的 kind 。

结果

这种元素的种类

getModifiers

Set<Modifier> getModifiers()

返回此元素的修饰符，不包括注释。 包含隐式修饰符，如接口成员的public和static修饰符。

结果

该元素的修饰符，如果没有，则为空集

getSimpleName

Name getSimpleName()

返回此元素的简单（不合格）名称。 通用类型的名称不包括对其正式类型参数的任何引用。 例如，类型元素java.util.Set<E>的简单名称是"Set" 。 如果此元素表示未命名的package ，则返回空名称。 如果代表constructor ，则返回名称“ <init> ”。 如果代表static initializer ，则返回名称“ <clinit> ”。 如果它代表一个anonymous class或instance initializer ，则返回一个空的名称。

结果

这个元素的简单名称

另请参见：

PackageElement.getSimpleName() ， ExecutableElement.getSimpleName() ， TypeElement.getSimpleName() ， VariableElement.getSimpleName()

getEnclosingElement

Element getEnclosingElement()

返回这个元素所在的最内层元素。

• 如果这个元素是一个声明在另一个元素的声明中立即包含声明的元素，则返回该另一个元素。
• 如果是top-level type ，则返回其包。
• 如果是package ，则返回null 。
• 如果这是type parameter ， the generic element类型参数的返回。
• 如果这是method or constructor parameter ， the executable element这说明当返回的参数。

结果

封闭元素，如果没有， null

另请参见：

Elements.getPackageOf(javax.lang.model.element.Element)

getEnclosedElements

List<? extends Element> getEnclosedElements()

返回由这个元素直接包围的松散元素。 A class or interface被认为包含它直接声明的字段，方法，构造函数和成员类型。 一个package封装了顶层的类和接口，但不包括子包。 目前还没有其他类型的要素包含任何要素; 然而，这可能会随着API或编程语言的发展而改变。

请注意，某些种类的元素可以使用ElementFilter中的方法进行分离。

结果

封闭的元素，如果没有空列表

另请参见：

PackageElement.getEnclosedElements() ， TypeElement.getEnclosedElements() ， Elements.getAllMembers(javax.lang.model.element.TypeElement)

See The Java™ Language Specification:

8.8.9默认构造函数，8.9枚

equals

boolean equals(Object obj)

返回true如果参数表示相同的元件如this ，或false否则。

请注意，元素的身份涉及不能直接从元素的方法访问的隐式状态，包括关于不相关类型的存在的状态。 即使“相同”元素被建模， 也不应该期望由这些接口的不同实现创建的元素对象是相等的; 这类似于通过不同的类加载器加载的相同类文件的类对象。

重写：

equals在 Object

参数

obj - 要与此元素进行比较的对象

结果

true如果指定的对象表示与此相同的元素

另请参见：

Object.hashCode() ， HashMap

hashCode

int hashCode()

服从的总承包 Object.hashCode 。

重写：

hashCode在 Object

结果

该对象的哈希码值。

另请参见：

equals(java.lang.Object)

getAnnotationMirrors

List<? extends AnnotationMirror> getAnnotationMirrors()

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

要获得继承的注释，请使用getAllAnnotationMirrors 。

Specified by:

getAnnotationMirrors在接口 AnnotatedConstruct

结果

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

从以下版本开始：

1.6

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.

Specified by:

getAnnotation中的 AnnotatedConstruct

参数类型

A - 注释类型

参数

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

结果

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

从以下版本开始：

1.6

另请参见：

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

accept

<R,P> R accept(ElementVisitor<R,P> v,
               P p)

将访问者应用于此元素。

参数类型

R - 访问者方法的返回类型

P - 访问者方法的附加参数类型

参数

v - 这个元素上的访问者

p - 访问者的附加参数

结果

访客指定的结果