Elements (Java Platform SE 8 )

```
public interface Elements
```
用于操作程序元素的实用方法。
兼容性注意：方法可能会增加在未来的平台发布此接口。

从以下版本开始：

一点六

另请参见：

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)` 返回文档的文本（“文档”）元素的评论。
`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)
```
    返回文档的文本（“文档”）元素的评论。
    一个元素的文档注释是一个评论，从“/**”、一个“*/”的结束，和前面的元素，忽略空格。因此，一个文件的评论至少包含三个“*”字。对于文档注释的文本返回的是注释的处理形式，因为它出现在源代码中。领先的“/**“尾随”*/”被删除。对于评论最初的“/**”后的起跑线，领先的空格字符是丢弃任何连续的“*”角色出现在白色的空间或起始线。处理后的线，然后连接在一起（包括线端子）和返回。
    
    参数
    
    e -元素被检查
    
    结果
    
    该元素的文档注释，或 null如果没有
    
    See The Java™ Language Specification:
    
    3.6白色空间
  - isDeprecated
```
boolean isDeprecated(Element e)
```
    返回 true如果元素是过时的， false否则。
    
    参数
    
    e -元素被检查
    
    结果
    
    true如果元素是过时的， 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型方法说明：当作为三分之一型 C，然而
    class A { public void m() {} }
    interface B { void m(); }
    ...
    m1 = ...; // A.m
    m2 = ...; // B.m
    assert ! elements.overrides(m1, m2, elements.getTypeElement("A"));
    成员，在 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否则
    
    从以下版本开始：
    
    一点八
    
    See The Java™ Language Specification:
    
    9.8功能界面

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.

Interface Elements

方法摘要

方法详细信息

getPackageElement

getTypeElement

getElementValuesWithDefaults

getDocComment

isDeprecated

getBinaryName

getPackageOf

getAllMembers

getAllAnnotationMirrors

hides

overrides

getConstantExpression

printElements

getName

isFunctionalInterface