モジュール java.compiler

パッケージ javax.lang.model.util

インタフェースElements

public interface Elements

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

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

導入されたバージョン:

1.6

関連項目:

• ProcessingEnvironment.getElementUtils()

ネストされたクラスのサマリー

ネストされたクラス

修飾子と型	インタフェース	説明
static enum	Elements.Origin	要素または他の言語モデル項目のorigin。

メソッドのサマリー

修飾子と型	メソッド	説明
List<? extends AnnotationMirror>	getAllAnnotationMirrors(Element e)	直接存在しているか継承を介して存在しているかにかかわらず、要素に存在しているすべての注釈を返します。
List<? extends Element>	getAllMembers(TypeElement type)	継承されているか直接宣言されているかにかかわらず、型要素のすべてのメンバーを返します。
default Set<? extends ModuleElement>	getAllModuleElements()	現在の環境内のすべてのモジュール要素を返します。
default Set<? extends PackageElement>	getAllPackageElements(CharSequence name)	指定された正規名を持つすべてのパッケージ要素を返します。
default Set<? extends TypeElement>	getAllTypeElements(CharSequence name)	指定された正規名を持つすべての型要素を返します。
Name	getBinaryName(TypeElement type)	型要素のバイナリ名を返します。
String	getConstantExpression(Object value)	プリミティブ値または文字列を表す定数式のテキストを返します。
String	getDocComment(Element e)	要素のドキュメンテーション("Javadoc")コメントのテキストを返します。
Map<? extends ExecutableElement,? extends AnnotationValue>	getElementValuesWithDefaults(AnnotationMirror a)	デフォルトを含む注釈の要素の値を返します。
default TypeElement	getEnumConstantBody(VariableElement enumConstant)	引数がオプションのクラス本文で宣言されたenum定数である場合、enum定数のクラス本文を返します。それ以外の場合はnullを返します。
default JavaFileObject	getFileObjectOf(Element e)	この要素のファイル・オブジェクトを返すか、そのようなファイル・オブジェクトがない場合はnullを返します。
default ModuleElement	getModuleElement(CharSequence name)	完全修飾名を指定してモジュール要素を返します。
default ModuleElement	getModuleOf(Element e)	要素のモジュールを返します。
Name	getName(CharSequence cs)	引数と同じ文字シーケンスを持つ名前を返します。
default Elements.Origin	getOrigin(AnnotatedConstruct c, AnnotationMirror a)	指定された注釈ミラーのoriginを返します。
default Elements.Origin	getOrigin(Element e)	指定された要素のoriginを返します。
default Elements.Origin	getOrigin(ModuleElement m, ModuleElement.Directive directive)	指定されたモジュール・ディレクティブのoriginを返します。
default TypeElement	getOutermostTypeElement(Element e)	このような包含要素が存在する場合、要素が含まれる最も外側の型要素を返します。それ以外の場合は、 nullを返します。
PackageElement	getPackageElement(CharSequence name)	パッケージが環境内で一意に決定可能な場合、完全修飾名を指定してパッケージを返します。
default PackageElement	getPackageElement(ModuleElement module, CharSequence name)	指定されたモジュールから見た完全修飾名でパッケージを返します。
PackageElement	getPackageOf(Element e)	要素のパッケージを返します。
TypeElement	getTypeElement(CharSequence name)	型要素が環境内で一意に決定可能な場合、正規名を指定して型要素を返します。
default TypeElement	getTypeElement(ModuleElement module, CharSequence name)	指定されたモジュールから見た標準名で型要素を返します。
boolean	hides(Element hider, Element hidden)	型、メソッド、またはフィールドが別のものを覆い隠しているかどうかをテストします。
default boolean	isAutomaticModule(ModuleElement module)	モジュール要素が自動モジュールの場合はtrue、そうでない場合はfalseを返します。
default boolean	isBridge(ExecutableElement e)	実行可能要素がブリッジ・メソッドの場合はtrue、それ以外の場合はfalseを返します。
default boolean	isCanonicalConstructor(ExecutableElement e)	実行可能要素がレコードの正規コンストラクタであると判断できる場合はtrueを返し、それ以外の場合は falseを返します。
default boolean	isCompactConstructor(ExecutableElement e)	実行可能要素がレコードのコンパクト・コンストラクタであると判断できる場合はtrueを返し、それ以外の場合は falseを返します。
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)	要素の表現を、指定された順序で、指定されたライターに出力します。
default RecordComponentElement	recordComponentFor(ExecutableElement accessor)	指定されたアクセッサのレコード・コンポーネントを返します。

メソッドの詳細

getPackageElement

PackageElement getPackageElement(CharSequence name)

パッケージが環境内で一意に決定可能な場合、完全修飾名を指定してパッケージを返します。 モジュールを使用して実行している場合、指定された名前のパッケージが2段階のプロセスで検索されます:

• getPackageElement(ModuleElement, CharSequence)によって返された指定された名前を持つ空でないパッケージを検索します。ここで、指定されたModuleSymbolは任意の「ルート・モジュール」です。
• 上記で空のリストが生成された場合は、all modulesで指定された名前の監視可能パッケージを検索

このプロセスが単一の要素を含むリストになると、単一の要素が返され、それ以外の場合はnullが返されます。

パラメータ:

name - 完全修飾パッケージ名、または名前のないパッケージに対する空の文字列

戻り値:

指定されたパッケージ。パッケージを一意に判定できない場合はnull。

getPackageElement

default PackageElement getPackageElement(ModuleElement module, CharSequence name)

指定されたモジュールから見た完全修飾名でパッケージを返します。

実装要件:

このメソッドのデフォルト実装はnullを返します。

パラメータ:

module - ルックアップが起きる相対的なモジュール

name - 完全修飾パッケージ名、または名前のないパッケージに対する空の文字列

戻り値:

指定されたパッケージ、または見つからない場合はnull

導入されたバージョン:

9

関連項目:

• getAllPackageElements(java.lang.CharSequence)

getAllPackageElements

default Set<? extends PackageElement> getAllPackageElements(CharSequence name)

指定された正規名を持つすべてのパッケージ要素を返します。 パッケージ・エレメントが異なるモジュール内にある場合は、同じ正規名を持つ複数のパッケージ・エレメントが存在する可能性があります。

実装要件:

このメソッドのデフォルトの実装では、getAllModuleElementsがコールされ、結果が格納されます。 モジュールのセットが空の場合、getPackageElement(name)はname引数を介してコールされます。 getPackageElement(name)がnullの場合、空のパッケージ要素セットが返されます。それ以外の場合、見つかったpackage要素を含む単一要素セットが返されます。 モジュールのセットが空でない場合、モジュールは反復され、getPackageElement(module, name)のnull以外の結果はセットに蓄積されます。 その後、セットが返されます。

パラメータ:

name - 正規名

戻り値:

パッケージ要素、または名前のパッケージが見つからない場合は空のセット

導入されたバージョン:

9

関連項目:

• getPackageElement(ModuleElement, CharSequence)

getTypeElement

TypeElement getTypeElement(CharSequence name)

型要素が環境内で一意に決定可能な場合、正規名を指定して型要素を返します。 モジュールを使用して実行している場合、指定された名前の型要素が2段階のプロセスで検索されます:

• getTypeElement(ModuleElement, CharSequence)によって返された指定された名前を持つ型要素を検索します。ここで、指定されたModuleSymbolは任意の「ルート・モジュール」です。
• 上記で空のリストが生成された場合は、指定された名前の監視可能なタイプ要素をall modulesで検索

このプロセスが単一の要素を含むリストになると、単一の要素が返され、それ以外の場合はnullが返されます。

パラメータ:

name - 正規名

戻り値:

名前付きの型要素。型要素を一意に判定できない場合はnull。

getTypeElement

default TypeElement getTypeElement(ModuleElement module, CharSequence name)

指定されたモジュールから見た標準名で型要素を返します。

実装要件:

このメソッドのデフォルト実装はnullを返します。

パラメータ:

module - ルックアップが起きる相対的なモジュール

name - 正規名

戻り値:

名前付き型要素。見つからない場合はnull

導入されたバージョン:

9

関連項目:

• getAllTypeElements(java.lang.CharSequence)

getAllTypeElements

default Set<? extends TypeElement> getAllTypeElements(CharSequence name)

指定された正規名を持つすべての型要素を返します。 型要素が異なるモジュール内にある場合は、同じ正規名を持つ複数の型要素が存在する可能性があります。

実装要件:

このメソッドのデフォルトの実装では、getAllModuleElementsがコールされ、結果が格納されます。 モジュールのセットが空の場合、getTypeElement(name)はname引数を介してコールされます。 getTypeElement(name)がnullの場合、型要素の空のセットが返されます。それ以外の場合、検出された型要素を持つ単一要素セットが返されます。 モジュールのセットが空でない場合、モジュールは反復され、getTypeElement(module, name)のnull以外の結果はセットに蓄積されます。 その後、セットが返されます。

パラメータ:

name - 正規名

戻り値:

型要素、または名前の型が見つからない場合は空のセット

導入されたバージョン:

9

関連項目:

• getTypeElement(ModuleElement, CharSequence)

getModuleElement

default ModuleElement getModuleElement(CharSequence name)

完全修飾名を指定してモジュール要素を返します。 リクエストされたモジュールが見つからない場合、nullが戻されます。 モジュールが見つからない状況の1つは、モジュールがない「ソース・バージョン」用に構成された注釈処理環境など、環境にモジュールが含まれていない場合です。

実装要件:

このメソッドのデフォルト実装はnullを返します。

パラメータ:

name - 名前、または名前のないモジュールの空の文字列

戻り値:

名前付きモジュール要素、または見つからない場合はnull

導入されたバージョン:

9

関連項目:

• getAllModuleElements()

getAllModuleElements

default Set<? extends ModuleElement> getAllModuleElements()

現在の環境内のすべてのモジュール要素を返します。 モジュールが存在しない場合は、空のセットが返されます。 モジュールが存在しない「ソース・バージョン」用に構成された注釈処理環境など、環境にモジュールが含まれていない場合に、モジュールが存在しない状況が発生します。

APIのノート:

環境にモジュールが含まれている場合は、名前付きモジュールと「名前のないモジュール」の両方が返されます。

実装要件:

このメソッドのデフォルトの実装は、空のセットを返します。

戻り値:

既知のモジュール要素、またはモジュールがない場合は空のセット

導入されたバージョン:

9

関連項目:

• getModuleElement(CharSequence)

getElementValuesWithDefaults

Map<? extends ExecutableElement,? extends AnnotationValue> getElementValuesWithDefaults(AnnotationMirror a)

デフォルトを含む注釈の要素の値を返します。

パラメータ:

a - 調べる対象の注釈

戻り値:

注釈要素の値(デフォルトを含む)

関連項目:

• AnnotationMirror.getElementValues()

getDocComment

String getDocComment(Element e)

要素のドキュメンテーション("Javadoc")コメントのテキストを返します。

要素のドキュメント・コメントは、"/**"で始まり、別の"*/"で終わり、要素の直前にあり、空白、注釈、行末コメント( "//"コメント)、およびドキュメント・コメントではない中間従来のコメント("/* ... */"コメント)を無視します。 したがって、ドキュメンテーション・コメントには、少なくとも3つの "*"文字が含まれます。 ドキュメント・コメントに返されるテキストは、ソース・コードに表示される処理済のコメント形式です。

• 先頭の"/**"は、その行の空白文字の直後に続くものと同様に削除されます。 行のすべての文字を削除しても、返されたコメントには影響しません。
• 最初の"/**"の後に始まるdocコメントの後続の行では、行がzero文字以上の空白文字で始まり、その後にone文字以上の"*"文字が続く場合、それらの先頭の空白文字は、空白の後に出現する連続した"*"文字であるかのように破棄されます。 それ以外の場合、行に記述された形式のプレフィクスがない場合、行全体が保持されます。
• 末尾の"*/"が削除されます。 末尾の"*/"を含む行は、前述のように先頭のスペースと"*"文字も削除されます。 行のすべての文字を削除しても、返されたコメントには影響しません。

その後、処理された行は連結され(改行文字を含む)、返されます。

パラメータ:

e - 調べる対象の要素

戻り値:

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

Java言語仕様を参照してください:

「3.6 ホワイト・スペース」
「3.7 コメント」

isDeprecated

boolean isDeprecated(Element e)

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

パラメータ:

e - 調べる対象の要素

戻り値:

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

getOrigin

default Elements.Origin getOrigin(Element e)

指定された要素のoriginを返します。

このメソッドがEXPLICITを返し、要素がクラス・ファイルから作成された場合、その要素は実際にはソース・コードで明示的に宣言された構文に対応していない可能性があります。 これは、ソース・コードからの情報を保持するクラス・ファイル形式の忠実度の制限によるものです。 たとえば、クラス・ファイル形式の少なくとも一部のバージョンでは、コンストラクタがプログラマによって明示的に宣言されたか、「デフォルト・コンストラクタ」として暗黙的に宣言されたかは保持されません。

実装要件:

このメソッドのデフォルト実装では、EXPLICITが返されます。

パラメータ:

e - 調べる対象の要素

戻り値:

指定された要素のorigin

導入されたバージョン:

9

getOrigin

default Elements.Origin getOrigin(AnnotatedConstruct c, AnnotationMirror a)

指定された注釈ミラーのoriginを返します。 注釈ミラーは、繰返し可能な注釈インタフェースの繰返し注釈を保持するために使用される、暗黙的に宣言された「コンテナ注釈」である場合、mandatedです。

このメソッドがEXPLICITを返し、注釈ミラーがクラス・ファイルから作成された場合、その要素は実際にはソース・コードで明示的に宣言された構文に対応していない可能性があります。 これは、ソース・コードからの情報を保持するクラス・ファイル形式の忠実度の制限によるものです。 たとえば、クラス・ファイル形式の少なくとも一部のバージョンでは、注釈がプログラマによって明示的に宣言されたか、または「コンテナ注釈」として暗黙的に宣言されたかは保持されません。

実装要件:

このメソッドのデフォルト実装では、EXPLICITが返されます。

パラメータ:

c - 注釈ミラーが変更する構成

a - 検査されている注釈ミラー

戻り値:

指定された注釈ミラーのorigin

Java言語仕様を参照してください:

「9.6.3 繰返し可能な注釈インタフェース」
「9.7.5 同じインタフェースの複数の注釈」

導入されたバージョン:

9

getOrigin

default Elements.Origin getOrigin(ModuleElement m, ModuleElement.Directive directive)

指定されたモジュール・ディレクティブのoriginを返します。

このメソッドがEXPLICITを返し、モジュール・ディレクティブがクラス・ファイルから作成された場合、モジュール・ディレクティブは、実際にはソース・コードで明示的に宣言された構文に対応していない場合があります。 これは、ソース・コードからの情報を保持するクラス・ファイル形式の忠実度の制限によるものです。 たとえば、クラス・ファイル形式の少なくとも一部のバージョンでは、usesディレクティブがプログラマによって明示的に宣言されたか、合成コンストラクトとして追加されたかは保持されません。

ソース・コードからの情報を保持するクラス・ファイル形式の忠実度の制限により、クラス・ファイルからディレクティブが作成された場合、実装はディレクティブのオリジン・ステータスを確実に決定できない場合があります。

実装要件:

このメソッドのデフォルト実装では、EXPLICITが返されます。

パラメータ:

m - ディレクティブのモジュール

directive - モジュール・ディレクティブが調べられている

戻り値:

指定されたモジュール・ディレクティブのorigin

導入されたバージョン:

9

isBridge

default boolean isBridge(ExecutableElement e)

実行可能要素がブリッジ・メソッドの場合はtrue、それ以外の場合はfalseを返します。

実装要件:

このメソッドのデフォルト実装はfalseを返します。

パラメータ:

e - 実行可能ファイルが検査されている

戻り値:

実行可能要素がブリッジ・メソッドの場合はtrue、そうでない場合はfalse

導入されたバージョン:

9

getBinaryName

Name getBinaryName(TypeElement type)

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

パラメータ:

type - 調べる対象の型要素

戻り値:

型要素の「バイナリ名」

Java言語仕様を参照してください:

13.1 バイナリの形式

関連項目:

• TypeElement.getQualifiedName()

getPackageOf

PackageElement getPackageOf(Element e)

要素のパッケージを返します。 パッケージのパッケージはそれ自身です。 モジュールのパッケージはnullです。 トップレベルのクラスまたはインタフェースのパッケージは、その「囲みパッケージ」です。 そうでない場合、要素のパッケージは「囲み要素」のパッケージと同じです。

パラメータ:

e - 調べる対象の要素

戻り値:

要素のパッケージ

getModuleOf

default ModuleElement getModuleOf(Element e)

要素のモジュールを返します。 モジュールのモジュールはそれ自体です。 パッケージに「囲み要素」としてモジュールがある場合、そのモジュールはパッケージのモジュールです。 パッケージの囲み要素がnullの場合、パッケージ・モジュールに対してnullが戻されます。 (パッケージにnullモジュールが含まれている場合の1つは、環境にモジュールが含まれていない場合です。このようなモジュールは、モジュールを含まない「ソース・バージョン」用に構成されている注釈処理環境などです。) それ以外の場合、要素のモジュールは要素のモジュール「パッケージ」と等しくなります。

実装要件:

このメソッドのデフォルト実装はnullを返します。

パラメータ:

e - 調べる対象の要素

戻り値:

要素のモジュール

導入されたバージョン:

9

getAllMembers

List<? extends Element> getAllMembers(TypeElement type)

継承されているか直接宣言されているかにかかわらず、型要素のすべてのメンバーを返します。 クラスについては、結果にはコンストラクタも含まれますが、ローカル・クラスや匿名クラスは含まれません。

APIのノート:

特定の種類の要素は、ElementFilterのメソッドを使用して分離できます。

パラメータ:

type - 調べる対象の型

戻り値:

型のすべてのメンバー

関連項目:

• Element.getEnclosedElements()

getOutermostTypeElement

default TypeElement getOutermostTypeElement(Element e)

このような包含要素が存在する場合、要素が含まれる最も外側の型要素を返します。それ以外の場合は、 nullを返します。 「モジュール」およびpackagesには含まれるタイプ要素がないため、これらの種類の要素に対してnullが返されます。 top-levelクラスまたはインタフェースは、最も外側の型要素です。

実装要件:

このメソッドのデフォルトの実装では、まず引数の種類をチェックします。 PACKAGE、 MODULEおよびOTHERなどの要素の場合は、nullが返されます。 他の種類の要素については、その要素がトップレベルのクラスかインタフェースかを調べます。 その場合、その要素が返されます。それ以外の場合は、トップレベルのクラスまたはインタフェースが見つかるまで、「囲み要素」チェーンが続きます。 最終的な最上位クラスまたはインタフェースの要素が返されます。

パラメータ:

e - 調べる対象の要素

戻り値:

このような包含要素が存在する場合、要素が含まれる最も外側の型要素。それ以外の場合は、 nullを返します

導入されたバージョン:

18

関連項目:

• Element.getEnclosingElement()

getAllAnnotationMirrors

List<? extends AnnotationMirror> getAllAnnotationMirrors(Element e)

直接存在しているか継承を介して存在しているかにかかわらず、要素に存在しているすべての注釈を返します。

このメソッドによって返される注釈は宣言注釈であることに注意してください。

パラメータ:

e - 調べる対象の要素

戻り値:

要素のすべての注釈

関連項目:

• Element.getAnnotationMirrors()
• AnnotatedConstruct

hides

boolean hides(Element hider, Element hidden)

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

パラメータ:

hider - 先頭の要素

hidden - 2番目の要素

戻り値:

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

Java言語仕様を参照してください:

8.4.8 継承、オーバーライドおよび非表示

overrides

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

あるメソッドが指定されたクラスまたはインタフェースのメンバーとして、別のメソッドをオーバーライドするかどうかをテストします。 非抽象メソッドが抽象メソッドをオーバーライドする場合は、前者が後者を実装するとも言われます。 JLS 8.4.8.1で示されているように、メソッドはそれ自体をオーバーライドしません。 オーバーライド関係は「再帰的」です。

もっとも単純で一般的な使用法では、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"));

ただし、サード・クラスの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 - 名前として返される文字シーケンス

戻り値:

引数と同じ文字シーケンスを持つ名前

isFunctionalInterface

boolean isFunctionalInterface(TypeElement type)

この型要素が関数型インタフェースである場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ:

type - 調べる対象の型要素

戻り値:

type要素が関数型インタフェースの場合はtrue、それ以外の場合はfalse

Java言語仕様を参照してください:

9.8 関数型インタフェース

導入されたバージョン:

1.8

isAutomaticModule

default boolean isAutomaticModule(ModuleElement module)

モジュール要素が自動モジュールの場合はtrue、そうでない場合はfalseを返します。

実装要件:

このメソッドのデフォルト実装は falseを返します。

パラメータ:

module - 検査するモジュール要素

戻り値:

モジュール要素が自動モジュールの場合はtrue、それ以外の場合はfalse

Java言語仕様を参照してください:

7.7.1 依存性

導入されたバージョン:

17

getEnumConstantBody

default TypeElement getEnumConstantBody(VariableElement enumConstant)

引数がオプションのクラス本文で宣言されたenum定数である場合、enum定数のクラス本文を返します。それ以外の場合はnullを返します。

実装要件:

このメソッドのデフォルトの実装では、引数が enum定数の場合は UnsupportedOperationExceptionがスローされ、そうでない場合はIllegalArgumentExceptionがスローされます。

パラメータ:

enumConstant - 列挙定数

戻り値:

引数がオプションのクラス本文で宣言されたenum定数の場合はenum定数のクラス本文、それ以外の場合はnull。

例外:

IllegalArgumentException - 引数がenum定数でない場合

Java言語仕様を参照してください:

8.9.1 enum定数

導入されたバージョン:

22

recordComponentFor

default RecordComponentElement recordComponentFor(ExecutableElement accessor)

指定されたアクセッサのレコード・コンポーネントを返します。 指定されたメソッドがレコード・コンポーネント・アクセッサでない場合、nullを返します。

実装要件:

このメソッドのデフォルト実装では、アクセッサを含む要素にRECORD型が含まれているかどうかを調べます(この場合、アクセッサを囲む要素のすべてのレコード・コンポーネントはElementFilter.recordComponentsIn(Iterable)を呼び出すことで取得されます)。 取得されたレコード・コンポーネントの1つ以上のアクセッサが、このメソッドへパラメータとして渡されたアクセッサと等しい場合、その他のケースのnullでは、そのレコード・コンポーネントが返されます。

パラメータ:

accessor - レコード・コンポーネントの検索メソッド。

戻り値:

レコード・コンポーネント、または指定されたメソッドがレコード・コンポーネント・アクセサではない場合はnull

導入されたバージョン:

16

isCanonicalConstructor

default boolean isCanonicalConstructor(ExecutableElement e)

実行可能要素がレコードの正規コンストラクタであると判断できる場合はtrueを返し、それ以外の場合は falseを返します。 実行可能要素がクラス・ファイルによって構築される場合など、コンストラクタが正規コンストラクタであるかどうかを判断するための情報が不十分な場合があることに注意してください。 このような場合、falseが返されます。

実装要件:

このメソッドのデフォルトの実装では、無条件にfalseが返されます。

パラメータ:

e - 実行可能ファイルが検査されている

戻り値:

実行可能要素がレコードの正規コンストラクタであると判断できる場合はtrue、それ以外の場合は false

Java言語仕様を参照してください:

「8.10.4.1 標準正規の標準コンストラクタ」

導入されたバージョン:

20

isCompactConstructor

default boolean isCompactConstructor(ExecutableElement e)

実行可能要素がレコードのコンパクト・コンストラクタであると判断できる場合はtrueを返し、それ以外の場合は falseを返します。 コンパクト・コンストラクタも「正規コンストラクタ」です。 場合によっては、実行可能要素がクラス・ファイルによって構築される場合など、コンストラクタがコンパクトなコンストラクタであるかどうかを判断するための十分な情報がないことがあります。 このような場合、falseが返されます。

実装要件:

このメソッドのデフォルトの実装では、無条件にfalseが返されます。

パラメータ:

e - 実行可能ファイルが検査されている

戻り値:

実行可能要素がレコードのコンパクト・コンストラクタであると判断できる場合はtrue、それ以外の場合は false

Java言語仕様を参照してください:

「8.10.4.2 コンパクトな正規コンストラクタ」

導入されたバージョン:

20

getFileObjectOf

default JavaFileObject getFileObjectOf(Element e)

この要素のファイル・オブジェクトを返すか、そのようなファイル・オブジェクトがない場合はnullを返します。

返されるファイル・オブジェクトは、要素の構成に使用される情報の「参照表現」用です。 たとえば、コンパイルまたは注釈の処理中に、クラスFooのソース・ファイルがクラス・ファイルにコンパイルされると、Fooを表す要素に対して返されるファイル・オブジェクトは、クラス・ファイルではなくソース・ファイル用になります。

実装では、このメソッドの機能をサポートしないことを選択できます。この場合、UnsupportedOperationExceptionがスローされます。

注釈処理のコンテキストでは、要素が初期入力の一部として含まれていた場合、または注釈処理ツールの実行中に含まれているファイルが作成された場合、null以外の値が返されます。 それ以外の場合は、 nullが返されます。 注釈処理で、「クラス・ファイルが作成されます」の場合、そのクラス・ファイルは要素の参照表現として機能します。

ファイル・オブジェクトがある場合、パッケージのファイル・オブジェクトはpackage-infoファイルになります。 パッケージが存在し、パッケージ内のソース・ファイルまたはクラス・ファイルの作成から注釈処理の実行中にパッケージが(暗黙的)が作成された場合でも、package-infoファイルがない場合があります。 「名前のないパッケージ」はコンパイル・ユニットで宣言できないため、nullファイルを持ちます。

ファイル・オブジェクトがある場合、モジュールのファイル・オブジェクトはmodule-infoファイルになります。 「名前のないモジュール」はコンパイル・ユニットで宣言できないため、 nullファイルを持ちます。 「自動モジュール」は暗黙的に宣言されるため、nullファイルを持ちます。

ファイル・オブジェクトがある場合、最上位のpublicクラスまたはインタフェースのファイル・オブジェクトは、そのクラスまたはインタフェースに対応するソースまたはクラス・ファイルになります。 この場合、通常、ファイル名の先頭部分がクラスまたはインタフェースの名前と一致します。 単一のコンパイル・ユニットは、ファイル名に対応するプライマリpublicクラスや、ファイル名に対応する1つ以上の「補助動詞」クラスまたは名前がファイル名に対応しないインタフェースなど、複数のトップレベル・クラスおよびインタフェースを定義できます。 ソース・ファイルが補助クラスまたはインタフェースの参照表現を提供している場合、プライマリ・クラスのファイルが返されます。 (補助クラスまたはインタフェースは、package-infoソース・ファイルでも定義できます。この場合、package-infoファイルのファイルが返されます。) クラス・ファイルが補助クラスまたはインタフェースの参照表現を提供している場合、補助クラスの個別のクラス・ファイルが返されます。

ネストされたクラスまたはインタフェースの場合は、ファイル・オブジェクトがある場合:

• ソース・ファイルが参照表現を提供している場合、ファイル・オブジェクトは「最も外側の囲み」クラスまたはインタフェースのオブジェクトになります
• クラス・ファイルが参照表現を提供している場合、ファイル・オブジェクトはネストされたクラスまたはインタフェースそのものになります

「変数」、「メソッドおよびコンストラクタ」など、他の語句で囲まれた要素の場合、ファイル・オブジェクトには、字句で囲まれた要素の「囲み要素」に関連付けられたオブジェクトが含まれます。

実装要件:

デフォルトの実装では、UnsupportedOperationExceptionが無条件にスローされます。

パラメータ:

e - ファイル・オブジェクトを検索する要素

戻り値:

この要素のファイル・オブジェクト、またはそのようなファイル・オブジェクトがない場合はnull

例外:

UnsupportedOperationException - この機能がサポートされていない場合

導入されたバージョン:

18