Elements (Java Platform SE 8 )

```
public interface Elements
```
对程序元素进行操作的实用方法。
兼容性注意：在将来的平台版本中可能会添加到此界面中的方法。

从以下版本开始：

1.6

另请参见：

ProcessingEnvironment.getElementUtils()

方法摘要

所有方法接口方法抽象方法
Modifier and Type	Method and Description
`List<? extends AnnotationMirror>`	`getAllAnnotationMirrors(Element e)` 返回元素上存在的所有注释，无论是直接存在还是通过继承存在。
`List<? extends Element>`	`getAllMembers(TypeElement type)` 返回类型元素的所有成员，无论是继承还是直接声明。
`Name`	`getBinaryName(TypeElement type)` 返回类型元素的二进制名称。
`String`	`getConstantExpression(Object value)` 返回表示原始值或字符串的常量表达式的文本。
`String`	`getDocComment(Element e)` 返回元素的文档（“Javadoc”）注释的文本。
`Map<? extends ExecutableElement,? extends AnnotationValue>`	`getElementValuesWithDefaults(AnnotationMirror a)` 返回注释元素的值，包括默认值。
`Name`	`getName(CharSequence cs)` 返回与参数相同的字符序列的名称。
`PackageElement`	`getPackageElement(CharSequence name)` 返回一个给定其全限定名称的包。
`PackageElement`	`getPackageOf(Element type)` 返回元素的包。
`TypeElement`	`getTypeElement(CharSequence name)` 返回给定其规范名称的类型元素。
`boolean`	`hides(Element hider, Element hidden)` 测试一种类型，方法或字段是否隐藏另一种。
`boolean`	`isDeprecated(Element e)` 返回 `true`如果元素已过时， `false`其他。
`boolean`	`isFunctionalInterface(TypeElement type)` 返回 `true`如果类型元件是功能性的接口， `false`否则。
`boolean`	`overrides(ExecutableElement overrider, ExecutableElement overridden, TypeElement type)` 测试一种方法，作为给定类型的成员，覆盖其他方法。
`void`	`printElements(Writer w, Element... elements)` 以指定的顺序将元素的表示打印到给定的作者。

- 方法详细信息
  - getPackageElement
```
PackageElement getPackageElement(CharSequence name)
```
    返回一个给定其全限定名称的包。
    
    参数
    
    name - 完全限定包名称，或未命名包的“”
    
    结果
    
    命名的包，或 null如果找不到
  - getTypeElement
```
TypeElement getTypeElement(CharSequence name)
```
    返回给定其规范名称的类型元素。
    
    参数
    
    name - 规范名称
    
    结果
    
    命名的类型元素，或 null如果它不能找到
  - getElementValuesWithDefaults
```
Map<? extends ExecutableElement,? extends AnnotationValue> getElementValuesWithDefaults(AnnotationMirror a)
```
    返回注释元素的值，包括默认值。
    
    参数
    
    a - 要检查的注释
    
    结果
    
    注释元素的值，包括默认值
    
    另请参见：
    
    AnnotationMirror.getElementValues()
  - getDocComment
```
String getDocComment(Element e)
```
    返回元素的文档（“Javadoc”）注释的文本。
    元素的文档注释是以“ /** ”开头的注释，以单独的“ */ ” */ ，并在元素之前立即忽略空格。因此，文档注释至少包含三个“ * ”字符。文档注释返回的文本是出现在源代码中的注释的处理形式。前导“ /** ”和尾随“ */ ”被删除。对于在初始“ /** ”之后开始的注释行，前导的空白字符将被丢弃，如同在空格或开始行之后出现的任何连续的“ * ”字符一样。然后处理的线连接在一起（包括线路终端器）并返回。
    
    参数
    
    e - 正在检查的元素
    
    结果
    
    元素的文档注释，如果没有， null
    
    See The Java™ Language Specification:
    
    3.6白色空间
  - isDeprecated
```
boolean isDeprecated(Element e)
```
    返回 true如果元素已过时， false其他。
    
    参数
    
    e - 正在检查的元素
    
    结果
    
    true如果该元素已被弃用， false false
  - getBinaryName
```
Name getBinaryName(TypeElement type)
```
    返回类型元素的 二进制名称 。
    
    参数
    
    type - 正在检查的类型元素
    
    结果
    
    二进制名称
    
    另请参见：
    
    TypeElement.getQualifiedName()
    
    See The Java™ Language Specification:
    
    13.1二进制形式
  - getPackageOf
```
PackageElement getPackageOf(Element type)
```
    返回元素的包。包装的包装本身就是它。
    
    参数
    
    type - 正在检查的元素
    
    结果
    
    一个元素的包装
  - getAllMembers
```
List<? extends Element> getAllMembers(TypeElement type)
```
    返回类型元素的所有成员，无论是继承还是直接声明。对于类，结果还包括其构造函数，但不包括本地或匿名类。
    请注意，某些类型的元素可以使用ElementFilter中的方法进行隔离。
    
    参数
    
    type - 正在检查的类型
    
    结果
    
    所有成员的类型
    
    另请参见：
    
    Element.getEnclosedElements()
  - getAllAnnotationMirrors
```
List<? extends AnnotationMirror> getAllAnnotationMirrors(Element e)
```
    返回元素上 存在的所有注释，无论是直接存在还是通过继承存在。
    
    参数
    
    e - 被检查的元素
    
    结果
    
    元素的所有注释
    
    另请参见：
    
    Element.getAnnotationMirrors() ， AnnotatedConstruct
  - hides
```
boolean hides(Element hider,
              Element hidden)
```
    测试一种类型，方法或字段是否隐藏另一种。
    
    参数
    
    hider - 第一个元素
    
    hidden - 第二个元素
    
    结果
    
    true当且仅当第一个元素隐藏第二个元素时
  - overrides
```
boolean overrides(ExecutableElement overrider,
                  ExecutableElement overridden,
                  TypeElement type)
```
    测试一种方法，作为给定类型的成员，覆盖其他方法。当非抽象方法覆盖抽象方法时，前者也被称为实现后者。
    在最简单和最典型的用法中， type参数的值将简单地是直接包含在overrider （可能覆盖的方法）的类或接口。例如，假设m1表示方法String.hashCode ，而m2表示Object.hashCode 。然后，我们可以问是否m1覆盖m2类中String （它）：
    
    assert elements.overrides(m1, m2, elements.getTypeElement("java.lang.String"));
    更有趣的情况下，可以通过下面的例子，其中在类型的方法来说明A不类型覆盖一个类似命名方法B ：
    class A { public void m() {} }
    interface B { void m(); }
    ...
    m1 = ...; // A.m
    m2 = ...; // B.m
    assert ! elements.overrides(m1, m2, elements.getTypeElement("A"));
    当作为第三类型的成员观看C ，然而，在该方法A并覆盖一个在B ：
    class C extends A implements B {}
    ...
    assert elements.overrides(m1, m2, elements.getTypeElement("C"));
    
    参数
    
    overrider - 第一种方法，可能的覆盖
    
    overridden - 第二种方法，可能被覆盖
    
    type - 第一种方法是其成员的类型
    
    结果
    
    true当且仅当第一种方法覆盖第二种方法时
    
    See The Java™ Language Specification:
    
    8.4.8继承，覆盖和隐藏，9.4.1继承和覆盖
  - getConstantExpression
```
String getConstantExpression(Object value)
```
    返回表示原始值或字符串的常量表达式的文本。返回的文本是适合代表源代码中的值的形式。
    
    参数
    
    value - 一个原始值或字符串
    
    结果
    
    一个常量表达式的文本
    
    异常
    
    IllegalArgumentException - 如果参数不是原始值或字符串
    
    另请参见：
    
    VariableElement.getConstantValue()
  - printElements
```
void printElements(Writer w,
                   Element... elements)
```
    以指定的顺序将元素的表示打印到给定的作者。这种方法的主要目的是用于诊断。输出的确切格式未指定，可能会更改。
    
    参数
    
    w - 作者将输出打印到
    
    elements - 要打印的元素
  - getName
```
Name getName(CharSequence cs)
```
    返回与参数相同的字符序列的名称。
    
    参数
    
    cs - 作为名称返回的字符序列
    
    结果
    
    与参数的字符序列相同的名称
  - isFunctionalInterface
```
boolean isFunctionalInterface(TypeElement type)
```
    返回 true如果类型元件是功能性的接口， false否则。
    
    参数
    
    type - 正在检查的类型元素
    
    结果
    
    true如果元素是功能界面， false否则
    
    从以下版本开始：
    
    1.8
    
    See The Java™ Language Specification:
    
    9.8功能界面

Interface Elements

方法摘要

方法详细信息

getPackageElement

getTypeElement

getElementValuesWithDefaults

getDocComment

isDeprecated

getBinaryName

getPackageOf

getAllMembers

getAllAnnotationMirrors

hides

overrides

getConstantExpression

printElements

getName

isFunctionalInterface