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。

从以下版本开始：

一点六

另请参见：

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()

返回由该元素直接包含的元素，这个元素是松散的。一个 class or interface被认为将字段，方法，构造器，它直接宣布成员类型。一个 package封闭顶层的类和接口内，但并不认为将子包。其他类型的元素目前不考虑包含任何元素，但是，这可能会改变，因为这个的编程语言或编程语言的发展。

请注意，某些种类的元素可以在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

结果

直接在这个结构上的注释；如果没有的话，一个空的列表

从以下版本开始：

一点六

getAnnotation

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

如果这样的诠释是返回指定类型的这种构造的诠释，其他 null。

此方法返回的注释可以包含一个元素的值的类型是类。这个值不能直接返回：查找和加载类的必要信息（如类装载器使用）不可用，并可能无法加载所有的类。试图读取一个类对象通过调用返回的注释相关的方法将导致一个MirroredTypeException，从中可提取出相应的TypeMirror。同样，试图读一Class[]-valued元素将导致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

从以下版本开始：

一点六

另请参见：

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附加参数

结果

客人指定的结果