モジュール jdk.javadoc

パッケージ jdk.javadoc.doclet

インタフェースDocletEnvironment

public interface DocletEnvironment

ドックレットの1回の呼出しの操作環境を表します。 このオブジェクトは、プログラム構造、さまざまなユーティリティ、およびコマンド行でユーザーが指定した要素にアクセスするために使用できます。

導入されたバージョン:

9

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

ネストされたクラス

修飾子と型	インタフェース	説明
static enum	DocletEnvironment.ModuleMode	モジュール・ドキュメントの詳細レベルを指定するモード。

メソッドのサマリー

修飾子と型	メソッド	説明
DocTrees	getDocTrees()	DocTreesユーティリティ・クラスのインスタンスを返します。
Elements	getElementUtils()	Elementsユーティリティ・クラスのインスタンスを返します。
JavaFileObject.Kind	getFileKind(TypeElement type)	type要素のファイル・タイプを返します。
Set<? extends Element>	getIncludedElements()	ドキュメント内のincludedであるモジュール、パッケージおよびタイプの要素を返します。
JavaFileManager	getJavaFileManager()	ファイルの読取りおよび書込みに使用するファイル・マネージャを返します。
DocletEnvironment.ModuleMode	getModuleMode()	必要なモジュール・ドキュメント・レベルを返します。
SourceVersion	getSourceVersion()	読み取られたソース・ファイルのソース・バージョンを返します。
Set<? extends Element>	getSpecifiedElements()	ツールの起動時に要素specifiedを返します。
Types	getTypeUtils()	Typesユーティリティ・クラスのインスタンスを返します。
boolean	isIncluded(Element e)	ドキュメント内の要素がincludedである必要がある場合はtrueを返します。
boolean	isSelected(Element e)	要素がselectedの場合はtrueを返します。

メソッドの詳細

getSpecifiedElements

Set<? extends Element> getSpecifiedElements()

ツールの起動時に要素specifiedを返します。

戻り値:

指定された要素のセット

getIncludedElements

Set<? extends Element> getIncludedElements()

ドキュメント内のincludedであるモジュール、パッケージおよびタイプの要素を返します。

戻り値:

含まれる要素のセット

getDocTrees

DocTrees getDocTrees()

DocTreesユーティリティ・クラスのインスタンスを返します。 このクラスは、TreePath、DocCommentTreeなどにアクセスするためのメソッドを提供します。

戻り値:

docツリー上で動作するユーティリティ・クラス

getElementUtils

Elements getElementUtils()

Elementsユーティリティ・クラスのインスタンスを返します。 このクラスはelementsで操作するためのメソッドを提供します。

戻り値:

要素を操作するユーティリティ・クラス

getTypeUtils

Types getTypeUtils()

Typesユーティリティ・クラスのインスタンスを返します。 このクラスはtype mirrorsで操作するためのメソッドを提供します。

戻り値:

型ミラーで動作するユーティリティ・クラス

isIncluded

boolean isIncluded(Element e)

ドキュメント内の要素がincludedである必要がある場合はtrueを返します。

パラメータ:

e - 要素

戻り値:

含まれる場合はtrue、それ以外の場合はfalse

isSelected

boolean isSelected(Element e)

要素がselectedの場合はtrueを返します。

パラメータ:

e - 要素

戻り値:

選択されている場合はtrue、それ以外の場合はfalse

getJavaFileManager

JavaFileManager getJavaFileManager()

ファイルの読取りおよび書込みに使用するファイル・マネージャを返します。

戻り値:

ファイルの読み書きに使用されたファイル・マネージャ

getSourceVersion

SourceVersion getSourceVersion()

読み取られたソース・ファイルのソース・バージョンを返します。

戻り値:

ソース・バージョン

getModuleMode

DocletEnvironment.ModuleMode getModuleMode()

必要なモジュール・ドキュメント・レベルを返します。

戻り値:

必要なレベルのモジュール・ドキュメント

getFileKind

JavaFileObject.Kind getFileKind(TypeElement type)

type要素のファイル・タイプを返します。

パラメータ:

type - 型要素

戻り値:

ファイルの種類