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