模块 java.compiler

包 javax.lang.model.element

接口 TypeElement

所有父级接口：

AnnotatedConstruct , Element , Parameterizable , QualifiedNameable

public interface TypeElement extends Element , Parameterizable , QualifiedNameable 
      

表示类或接口程序元素。提供对有关类或接口及其成员的信息的访问。请注意，枚举类和记录类是特殊类型的类，注解是特殊类型的接口。

而 TypeElement 代表一个类或接口element，一个DeclaredType 代表一个类或接口类型，后者是一种用途（或调用的前者。这种区别在泛型类型中最为明显，单个元素可以定义整个类型族。例如，元素 java.util.Set 对应于参数化类型 java.util.Set<String> 和 java.util.Set<Number> （以及许多其他），以及原始类型 java.util.Set 。

此接口的每个返回元素列表的方法将按照程序信息的基础源的自然顺序返回它们。例如，如果底层信息源是 Java 源代码，则元素将按源代码顺序返回。

API 注意：

表示的类或接口可能有一个 参考表示（源代码或可执行输出）。多个类和接口可以共享相同的引用表示支持构造。例如，可以在同一个源文件中声明多个类和接口，包括但不限于：

• 一个 顶层 类或接口以及辅助类和接口
• 顶级类或接口以及其中的 嵌套类和接口

在注释处理的上下文中，类型元素可以是：

• 从初始输入创建到工具运行
• 从处理器编写的 源代码 或 类文件 创建
• 查询 在配置的环境中

自从：

1.6

参见：

• DeclaredType

方法总结

修饰符和类型	方法	描述
TypeMirror	asType()	返回此类或接口元素定义的类型，返回原型代表泛型类型的元素的类型。
List<? extends Element>	getEnclosedElements()	返回在该类或接口中直接声明的字段、方法、构造方法、记录组件以及成员类和接口。
Element	getEnclosingElement()	返回顶级类或接口的包，并返回 nested 类或接口的直接词法封闭元素。
List<? extends TypeMirror>	getInterfaces()	返回由此类直接实现或由该接口扩展的接口类型。
NestingKind	getNestingKind()	返回嵌套类此类或接口元素。
default List<? extends TypeMirror>	getPermittedSubclasses()	按声明顺序返回此类或接口元素的允许类。
Name	getQualifiedName()	返回此类或接口元素的完全限定名称。
default List<? extends RecordComponentElement>	getRecordComponents()	按声明顺序返回此类或接口元素的记录组件。
Name	getSimpleName()	返回此类或接口元素的简单名称。
TypeMirror	getSuperclass()	返回此类或接口元素的直接超类。
List<? extends TypeParameterElement>	getTypeParameters()	按声明顺序返回此类或接口元素的正式类型参数。

在接口 javax.lang.model.element.Element 中声明的方法

accept, equals, getAnnotation, getAnnotationMirrors, getAnnotationsByType, getKind, getModifiers, hashCode

方法详情

asType

TypeMirror  asType()
            

返回此类或接口元素定义的类型，返回原型代表泛型类型的元素的类型。

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

指定者：

asType 在接口 Element 中

返回：

此类型元素定义的类型

参见：

• Types.asMemberOf(DeclaredType, Element)
• Types.getDeclaredType(TypeElement, TypeMirror...)

getEnclosedElements

List <? extends Element > getEnclosedElements()
            

返回在该类或接口中直接声明的字段、方法、构造函数、记录组件以及成员类和接口。这包括任何 强制的 元素，例如（隐式）默认构造函数和枚举类的隐式 values 和 valueOf 方法。

指定者：

getEnclosedElements 在接口 Element 中

API 注意：

作为 一般精度要求 的特定实例和此接口所需的排序行为，将以自然顺序返回包含的元素列表，以获取有关类或接口的信息的原始来源。例如，如果有关类或接口的信息源自源文件，则元素将按源代码顺序返回。 （但是，在这种情况下，未指定 隐式声明 元素的顺序，例如默认构造函数。）

返回：

以正确顺序包含的元素，如果没有则为空列表

看Java 语言规范:

8.8.9 默认构造函数
8.9.3 枚举成员
8.10.3 记录成员

参见：

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

getNestingKind

NestingKind  getNestingKind()
            

返回嵌套类此类或接口元素。

返回：

此类或接口元素的内部类型

getQualifiedName

Name  getQualifiedName()
            

返回此类或接口元素的完全限定名称。更准确地说，它返回典范姓名。对于没有规范名称的本地类和匿名类，返回 空名。

泛型类或接口的名称不包括对其正式类型参数的任何引用。例如，接口 java.util.Set<E> 的完全限定名称是“java.util.Set”。嵌套类和接口使用“.”作为分隔符，如“java.util.Map.Entry”。

指定者：

getQualifiedName 在接口 QualifiedNameable 中

返回：

此类或接口的完全限定名称，如果没有则为空名称

看Java 语言规范:

6.7 完全限定名称和规范名称

参见：

• Elements.getBinaryName(javax.lang.model.element.TypeElement)

getSimpleName

Name  getSimpleName()
            

返回此类或接口元素的简单名称。对于匿名类，返回 空名。

指定者：

getSimpleName 在接口 Element 中

返回：

此类或接口的简单名称，匿名类的空名称

参见：

• PackageElement.getSimpleName()
• ExecutableElement.getSimpleName()
• getSimpleName()
• VariableElement.getSimpleName()
• ModuleElement.getSimpleName()
• RecordComponentElement.getSimpleName()

getSuperclass

TypeMirror  getSuperclass()
            

返回此类或接口元素的直接超类。如果此类或接口元素表示接口或类 java.lang.Object ，则返回种类为 NONE 的 NoType 。

返回：

直接超类，如果没有，则为 NoType

getInterfaces

List <? extends TypeMirror > getInterfaces()
            

返回由此类直接实现或由该接口扩展的接口类型。

返回：

由此类直接实现或由该接口扩展的接口类型，如果没有则为空列表

getTypeParameters

List <? extends TypeParameterElement > getTypeParameters()
            

按声明顺序返回此类或接口元素的正式类型参数。

指定者：

getTypeParameters 在接口 Parameterizable 中

返回：

形式类型参数，如果没有则为空列表

getRecordComponents

default List <? extends RecordComponentElement > getRecordComponents()
            

按声明顺序返回此类或接口元素的记录组件。

实现要求：

此方法的默认实现返回一个空的且不可修改的列表。

返回：

记录组件，如果没有，则为空列表

自从：

16

getPermittedSubclasses

default List <? extends TypeMirror > getPermittedSubclasses()
            

按声明顺序返回此类或接口元素的允许类。

实现要求：

此方法的默认实现返回一个空的且不可修改的列表。

返回：

允许的类，如果没有则为空列表

自从：

17

getEnclosingElement

Element  getEnclosingElement()
            

返回顶级类或接口的包，并返回 nested 类或接口的直接词法封闭元素。

指定者：

getEnclosingElement 在接口 Element 中

返回：

顶级类或接口的包，内部类或接口的直接词法封闭元素

参见：

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