インタフェース
javax.lang.model.element.Elementの使用

Elementを使用するパッケージ

パッケージ	説明
com.sun.source.tree	ソース・コードを抽象構文ツリー(Abstract Syntax Tree、AST)として表すためのインタフェースを提供します。
com.sun.source.util	抽象構文ツリー(Abstract Syntax Tree、AST)の操作のためのユーティリティを提供します。
javax.annotation.processing	注釈プロセッサを宣言し、注釈プロセッサが注釈処理ツール環境とやり取りできるようにするための機能。
javax.lang.model.element	Javaプログラミング言語の要素をモデル化するために使用されるインタフェースです。
javax.lang.model.type	Javaプログラミング言語の型をモデル化するために使用されるインタフェースです。
javax.lang.model.util	プログラム要素と型の処理を支援するユーティリティです。
jdk.javadoc.doclet	ドックレットAPIは、言語モデルAPIおよびコンパイラ・ツリーAPIと共に、クライアントがソースに埋め込まれたAPIコメントを含むプログラムおよびライブラリのソース・レベルの構造を検査できるようにする環境を提供します。

com.sun.source.treeでのElementの使用

型Elementの引数を持つ型を返すcom.sun.source.treeのメソッド

修飾子と型	メソッド	説明
Iterable<? extends Element>	Scope.getLocalElements()	このスコープに直接含まれる要素を返します。

com.sun.source.utilでのElementの使用

Elementを返すcom.sun.source.utilのメソッド

修飾子と型	メソッド	説明
abstract Element	DocTrees.getElement(DocTreePath path)	指定されたDocTreePathのリーフ・ノードによって参照される言語モデル要素、または未知の場合はnullを返します。
abstract Element	Trees.getElement(TreePath path)	指定されたTreePathによって識別されるTreeノードのElementを返します。

型Elementの引数を持つ型を返すcom.sun.source.utilのメソッド

修飾子と型	メソッド	説明
abstract Iterable<? extends Element>	JavacTask.analyze()	すべての分析を完了します。

型Elementのパラメータを持つcom.sun.source.utilのメソッド

修飾子と型	メソッド	説明
abstract DocCommentTree	DocTrees.getDocCommentTree(Element e)	指定された要素のドキュメント・コメント・ツリーを返します。
abstract DocCommentTree	DocTrees.getDocCommentTree(Element e, String relativePath)	指定された要素に相対してパスが指定された、指定されたファイルのドキュメント・コメント・ツリーを返します。
abstract TreePath	Trees.getPath(Element e)	指定されたElementのTreePathノードを返します。
abstract TreePath	Trees.getPath(Element e, AnnotationMirror a)	指定されたElementのAnnotationMirrorのTreePathノードを返します。
abstract TreePath	Trees.getPath(Element e, AnnotationMirror a, AnnotationValue v)	指定されたElementのAnnotationMirrorのAnnotationValueのTreePathノードを返します。
abstract Tree	Trees.getTree(Element element)	指定されたElementのTreeノードを返します。
abstract Tree	Trees.getTree(Element e, AnnotationMirror a)	指定されたElementのAnnotationMirrorのTreeノードを返します。
abstract Tree	Trees.getTree(Element e, AnnotationMirror a, AnnotationValue v)	指定されたElementのAnnotationMirrorのAnnotationValueのTreeノードを返します。
abstract boolean	Trees.isAccessible(Scope scope, Element member, DeclaredType type)	指定されたスコープ内で、指定された要素が、指定された型のメンバーとしてアクセス可能であるかどうかを判定します。

javax.annotation.processingでのElementの使用

Element型の引数を持つ型を返すjavax.annotation.processingのメソッド

修飾子と型	メソッド	説明
Set<? extends Element>	RoundEnvironment.getElementsAnnotatedWith(Class<? extends Annotation> a)	指定された注釈型を使って注釈を付けられた要素を返します。
Set<? extends Element>	RoundEnvironment.getElementsAnnotatedWith(TypeElement a)	指定された注釈型を使って注釈を付けられた要素を返します。
default Set<? extends Element>	RoundEnvironment.getElementsAnnotatedWithAny(Set<Class<? extends Annotation>> annotations)	指定された注釈型の1つ以上で注釈が付けられた要素を返します。
default Set<? extends Element>	RoundEnvironment.getElementsAnnotatedWithAny(TypeElement... annotations)	指定された注釈型の1つ以上で注釈が付けられた要素を返します。
Set<? extends Element>	RoundEnvironment.getRootElements()	以前のラウンドによって生成された注釈処理の「ルート要素」を返します。

Element型のパラメータを持つjavax.annotation.processingのメソッド

修飾子と型	メソッド	説明
JavaFileObject	Filer.createClassFile(CharSequence name, Element... originatingElements)	新しいクラス・ファイルを作成し、それへの書込みを可能にするオブジェクトを返します。
FileObject	Filer.createResource(JavaFileManager.Location location, CharSequence moduleAndPkg, CharSequence relativeName, Element... originatingElements)	書込み対象の新しい補助リソース・ファイルを作成し、それに対応するファイル・オブジェクトを返します。
JavaFileObject	Filer.createSourceFile(CharSequence name, Element... originatingElements)	新しいソース・ファイルを作成し、それへの書込みを可能にするオブジェクトを返します。
Iterable<? extends Completion>	AbstractProcessor.getCompletions(Element element, AnnotationMirror annotation, ExecutableElement member, String userText)	コンプリートの空の反復可能オブジェクトを返します。
Iterable<? extends Completion>	Processor.getCompletions(Element element, AnnotationMirror annotation, ExecutableElement member, String userText)	ある注釈に対する推奨のコンプリートから成る反復可能オブジェクトを、ツール・インフラストラクチャに返します。
void	Messager.printMessage(Diagnostic.Kind kind, CharSequence msg, Element e)	要素の位置における、指定された種類のメッセージを出力します。
void	Messager.printMessage(Diagnostic.Kind kind, CharSequence msg, Element e, AnnotationMirror a)	注釈の付いた要素の注釈ミラーの位置における、指定された種類のメッセージを出力します。
void	Messager.printMessage(Diagnostic.Kind kind, CharSequence msg, Element e, AnnotationMirror a, AnnotationValue v)	注釈の付いた要素の注釈ミラーに含まれる注釈値の位置における、指定された種類のメッセージを出力します。

javax.lang.model.elementでのElementの使用

javax.lang.model.elementでのElementのサブインタフェース

修飾子と型	インタフェース	説明
interface	ExecutableElement	クラスまたはインタフェースのメソッド、コンストラクタ、または初期化子(静的またはインスタンス)を表します(注釈型要素を含む)。
interface	ModuleElement	モジュール・プログラム要素を表します。
interface	PackageElement	パッケージのプログラム要素を表します。
interface	Parameterizable	型パラメータを持つ要素に対応するmixinインタフェースです。
interface	QualifiedNameable	修飾名を持つ要素に対応するmixinインタフェースです。
interface	RecordComponentElement	レコード・コンポーネントを表します。
interface	TypeElement	クラスまたはインタフェースのプログラム要素を表します。
interface	TypeParameterElement	ジェネリック的なクラス、インタフェース、メソッド、またはコンストラクタの要素の仮型パラメータを表します。
interface	VariableElement	フィールド、enum定数、メソッドまたはコンストラクタのパラメータ、ローカル変数、リソース変数、または例外パラメータを表します。

Elementを返すjavax.lang.model.elementのメソッド

修飾子と型	メソッド	説明
Element	Element.getEnclosingElement()	大まかに言うとこの要素を囲んでいる、もっとも内側の要素を返します。
Element	ModuleElement.getEnclosingElement()	モジュールが別の要素で囲まれていないので、nullを返します。
Element	PackageElement.getEnclosingElement()	このようなモジュールが存在する場合は包含するモジュールを返し、それ以外の場合はnullを返します。
Element	RecordComponentElement.getEnclosingElement()	このレコード・コンポーネントの囲み要素を返します。
Element	TypeElement.getEnclosingElement()	トップレベルのクラスまたはインタフェースのパッケージを戻し、「ネスト」クラスまたはインタフェースを直接囲んでいる字句要素を戻します。
Element	TypeParameterElement.getEnclosingElement()	この型パラメータのジェネリック要素を返します。
Element	VariableElement.getEnclosingElement()	この変数の包含する要素を返します。
Element	TypeParameterElement.getGenericElement()	この型パラメータによってパラメータ化されるジェネリック・クラス、インタフェース、メソッド、またはコンストラクタを返します。
Element	UnknownElementException.getUnknownElement()	未知の要素を返します。

Element型の引数を持つ型を返すjavax.lang.model.elementのメソッド

修飾子と型	メソッド	説明
List<? extends Element>	Element.getEnclosedElements()	大まかに言うとこの要素によって直接囲まれている要素を返します。
List<? extends Element>	ModuleElement.getEnclosedElements()	このモジュール内のパッケージを返します。
List<? extends Element>	PackageElement.getEnclosedElements()	このパッケージ内の最上位のクラスおよびインタフェースを返します。
List<? extends Element>	TypeElement.getEnclosedElements()	このクラスまたはインタフェースで直接宣言されているフィールド、メソッド、コンストラクタ、レコード・コンポーネント、およびメンバー・クラスとインタフェースを返します。

Element型のパラメータを持つjavax.lang.model.elementのメソッド

修飾子と型	メソッド	説明
default R	ElementVisitor.visit(Element e)	visit(e, null)と同等の簡易メソッドです。
R	ElementVisitor.visit(Element e, P p)	要素をビジットします。
R	ElementVisitor.visitUnknown(Element e, P p)	未知の種類の要素をビジットします。

Element型のパラメータを持つjavax.lang.model.elementのコンストラクタ

修飾子	コンストラクタ	説明
	UnknownElementException(Element e, Object p)	新しいUnknownElementExceptionを作成します。

javax.lang.model.typeでのElementの使用

Elementを返すjavax.lang.model.typeのメソッド

修飾子と型	メソッド	説明
Element	DeclaredType.asElement()	この型に対応する要素を返します。
Element	TypeVariable.asElement()	この型変数に対応する要素を返します。

javax.lang.model.utilでのElementの使用

Elementを返すjavax.lang.model.utilのメソッド

修飾子と型	メソッド	説明
Element	Types.asElement(TypeMirror t)	型に対応する要素を返します。

Element型の引数を持つ型を返すjavax.lang.model.utilのメソッド

修飾子と型	メソッド	説明
List<? extends Element>	Elements.getAllMembers(TypeElement type)	継承されているか直接宣言されているかにかかわらず、型要素のすべてのメンバーを返します。

Element型のパラメータを持つjavax.lang.model.utilのメソッド

修飾子と型	メソッド	説明
TypeMirror	Types.asMemberOf(DeclaredType containing, Element element)	指定された型のメンバーとして要素が参照される場合、あるいは指定された型に直接包含されるメンバーとして要素が参照される場合、要素の型を返します。
protected R	SimpleElementVisitor6.defaultAction(Element e, P p)	ビジット・メソッドのデフォルトのアクションです。
List<? extends AnnotationMirror>	Elements.getAllAnnotationMirrors(Element e)	直接存在しているか継承を介して存在しているかにかかわらず、要素に存在しているすべての注釈を返します。
String	Elements.getDocComment(Element e)	要素のドキュメンテーション("Javadoc")コメントのテキストを返します。
default ModuleElement	Elements.getModuleOf(Element e)	要素のモジュールを返します。
default Elements.Origin	Elements.getOrigin(Element e)	指定された要素のoriginを返します。
PackageElement	Elements.getPackageOf(Element e)	要素のパッケージを返します。
boolean	Elements.hides(Element hider, Element hidden)	型、メソッド、またはフィールドが別のものを覆い隠しているかどうかをテストします。
boolean	Elements.isDeprecated(Element e)	要素が非推奨の場合はtrue、それ以外の場合はfalseを返します。
void	Elements.printElements(Writer w, Element... elements)	要素の表現を、指定された順序で、指定されたライターに出力します。
R	ElementScanner6.scan(Element e)	v.scan(e, null)と同等の簡易メソッドです。
R	ElementScanner6.scan(Element e, P p)	e.accept(this, p)を呼び出すことで要素を処理します。サブクラスによって、このメソッドをオーバーライドできます。
R	AbstractElementVisitor6.visit(Element e)	プログラム要素のacceptメソッドに自身を渡し、追加のパラメータにnullを渡すかのようにして、その要素をビジットします。
R	AbstractElementVisitor6.visit(Element e, P p)	プログラム要素のacceptメソッドに自身を渡すかのようにして、その要素をビジットします。
R	AbstractElementVisitor6.visitUnknown(Element e, P p)	未知の種類の要素をビジットします。

Element型の型引数を持つjavax.lang.model.utilのメソッド・パラメータ

修飾子と型	メソッド	説明
static List<ExecutableElement>	ElementFilter.constructorsIn(Iterable<? extends Element> elements)	elements内のコンストラクタのリストを返します。
static Set<ExecutableElement>	ElementFilter.constructorsIn(Set<? extends Element> elements)	elements内のコンストラクタのセットを返します。
static List<VariableElement>	ElementFilter.fieldsIn(Iterable<? extends Element> elements)	elements内のフィールドのリストを返します。
static Set<VariableElement>	ElementFilter.fieldsIn(Set<? extends Element> elements)	elements内のフィールドのセットを返します。
static List<ExecutableElement>	ElementFilter.methodsIn(Iterable<? extends Element> elements)	elements内のメソッドのリストを返します。
static Set<ExecutableElement>	ElementFilter.methodsIn(Set<? extends Element> elements)	elements内のメソッドのセットを返します。
static List<ModuleElement>	ElementFilter.modulesIn(Iterable<? extends Element> elements)	elements内のモジュールのリストを返します。
static Set<ModuleElement>	ElementFilter.modulesIn(Set<? extends Element> elements)	elements内のモジュールのセットを返します。
static List<PackageElement>	ElementFilter.packagesIn(Iterable<? extends Element> elements)	elements内のパッケージのリストを返します。
static Set<PackageElement>	ElementFilter.packagesIn(Set<? extends Element> elements)	elements内のパッケージのセットを返します。
static List<RecordComponentElement>	ElementFilter.recordComponentsIn(Iterable<? extends Element> elements)	elementsのレコード・コンポーネントのリストを戻します。
static Set<RecordComponentElement>	ElementFilter.recordComponentsIn(Set<? extends Element> elements)	elementsの一連のレコード・コンポーネントを返します。
R	ElementScanner6.scan(Iterable<? extends Element> iterable, P p)	指定された要素で反復し、各要素に対してscan(Element, P)を呼び出します。
static List<TypeElement>	ElementFilter.typesIn(Iterable<? extends Element> elements)	elementsのクラスおよびインタフェースのリストを返します。
static Set<TypeElement>	ElementFilter.typesIn(Set<? extends Element> elements)	elements内の型のセットを返します。

jdk.javadoc.docletでのElementの使用

型Elementの引数を持つ型を返すjdk.javadoc.docletのメソッド

修飾子と型	メソッド	説明
Set<? extends Element>	DocletEnvironment.getIncludedElements()	ドキュメンテーションのincludedでなければならないモジュール、パッケージ、型要素を返します。
Set<? extends Element>	DocletEnvironment.getSpecifiedElements()	ツールが呼び出されたときに要素specifiedを返します。

型Elementのパラメータを持つjdk.javadoc.docletのメソッド

修飾子と型	メソッド	説明
boolean	DocletEnvironment.isIncluded(Element e)	ドキュメント内の要素がincludedの場合はtrueを返します。
boolean	DocletEnvironment.isSelected(Element e)	要素がselectedの場合はtrueを返します。
void	Reporter.print(Diagnostic.Kind kind, Element e, String msg)	エラー・メッセージを表示し、エラー数をインクリメントします。
String	Taglet.toString(List<? extends DocTree> tags, Element element)	生成された出力に含まれる、このタグの一連のインスタンスの文字列表現を返します。