javax.lang.model.util

インタフェース Elements

public interface Elements

プログラム要素で操作を行うためのユーティリティーメソッド。

互換性に関する注:プラットフォームの将来のリリースでは、このインタフェースにメソッドが追加される可能性があります。

導入されたバージョン:

1.6

関連項目:

ProcessingEnvironment.getElementUtils()

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
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	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") コメントのテキストを返します。

要素のドキュメンテーションコメントは、"/**" で始まり、個別の "*/" で終わるコメントであり、要素の直前に配置され、空白は無視されます。したがって、ドキュメンテーションコメントには、少なくとも 3 つの "*" 文字が含まれます。ドキュメンテーションコメントで返されるテキストは、ソースコードに表示されたとおりに処理された形式のコメントです。先頭の "/**" と末尾の "*/" は削除されます。コメントの行が最初の "/**" のあとに始まる場合、先行する空白文字は破棄されます。連続した "*" 文字が空白のあとに現れる場合や、これらの文字から行が始まるも場合も、同様に破棄されます。その後、処理された行は連結され (改行文字を含む)、返されます。

パラメータ:

e - 調べる対象の要素

戻り値:

要素のドキュメンテーションコメント。存在しない場合は null

『Java™ 言語仕様』を参照してください。

3.6 空白

isDeprecated

boolean isDeprecated(Element e)

要素が非推奨の場合は true、それ以外の場合は false を返します。

パラメータ:

e - 調べる対象の要素

戻り値:

要素が非推奨の場合は true、それ以外の場合は false

getBinaryName

Name getBinaryName(TypeElement type)

型要素のバイナリ名を返します。

パラメータ:

type - 調べる対象の型要素

戻り値:

バイナリ名

関連項目:

TypeElement.getQualifiedName()

『Java™ 言語仕様』を参照してください。

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

hides

boolean hides(Element hider,
            Element hidden)

型、メソッド、またはフィールドが別のものを覆い隠しているかどうかをテストします。

パラメータ:

hider - 先頭の要素

hidden - 2 番目の要素

戻り値:

先頭の要素が 2 番目の要素を覆い隠している場合に限り true

overrides

boolean overrides(ExecutableElement overrider,
                ExecutableElement overridden,
                TypeElement type)

指定された型のメンバーであるメソッドが別のメソッドをオーバーライドするかどうかをテストします。非抽象メソッドが抽象メソッドをオーバーライドする場合は、前者が後者を実装するとも言われます。

もっとも単純で一般的な使用法では、type パラメータの値は、メソッドをオーバーライドする可能性のある overrider を直接囲むクラスまたはインタフェースになります。たとえば、m1 がメソッド String.hashCode を表し、m2 がメソッド Object.hashCode を表すとします。String クラス内で m1 が m2 をオーバーライドするかどうかを次のように調べることができます。実際はオーバーライドします。

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"));

ただし、3 番目の型 C のメンバーとして参照されると、A のメソッドは B のメソッドをオーバーライドします。

class C extends A implements B {}
...
assert elements.overrides(m1, m2, elements.getTypeElement("C"));

パラメータ:

overrider - オーバーライドを行う可能性がある先頭のメソッド

overridden - オーバーライドされる可能性がある 2 番目のメソッド

type - メンバーである先頭のメソッドの型

戻り値:

先頭のメソッドが 2 番目のメソッドをオーバーライドする場合に限り true

『Java™ 言語仕様』を参照してください。

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 - 名前として返される文字シーケンス