public interface DocletEnvironment
ドックレットを1回呼び出す操作環境を表します。 このオブジェクトを使用して、プログラム構造、さまざまなユーティリティ、およびコマンド行でユーザーが指定した要素にアクセスできます。
- 導入されたバージョン:
- 9
-
ネストされたクラスのサマリー
-
メソッドのサマリー
修飾子と型メソッド説明DocTrees
ユーティリティ・クラスのインスタンスを戻します。Elements
ユーティリティ・クラスのインスタンスを戻します。getFileKind(TypeElement type)
型要素のファイルのタイプを返します。ドキュメンテーションのincludedでなければならないモジュール、パッケージ、型要素を返します。ファイルの読み書きに使用されるファイル・マネージャを返します。必要なレベルのモジュール・ドキュメントを返します。読み取られたソース・ファイルのソース・バージョンを返します。ツールが呼び出されたときに要素specifiedを返します。Types
ユーティリティ・クラスのインスタンスを戻します。boolean
isIncluded(Element e)
ドキュメント内の要素がincludedの場合はtrueを返します。boolean
isSelected(Element e)
要素がselectedの場合はtrueを返します。
-
メソッドの詳細
-
getSpecifiedElements
ツールが呼び出されたときに要素specifiedを返します。- 戻り値:
- 指定された要素のセット
-
getIncludedElements
ドキュメンテーションのincludedでなければならないモジュール、パッケージ、型要素を返します。- 戻り値:
- 含まれる要素のセット
-
getDocTrees
DocTrees getDocTrees()DocTrees
ユーティリティ・クラスのインスタンスを戻します。 このクラスは、TreePath
s、DocCommentTree
sにアクセスするためのメソッドを提供します。- 戻り値:
- 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
- 型要素- 戻り値:
- ファイルの種類
-