モジュール jdk.javadoc
パッケージ jdk.javadoc.doclet

インタフェースDocletEnvironment

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

    • メソッドの詳細

      • getSpecifiedElements

        Set<? extends Element> getSpecifiedElements()
        ツールが呼び出されたときに指定された要素を返します。
        戻り値:
        指定された要素のセット

      • getIncludedElements

        Set<? extends Element> getIncludedElements()
        ドキュメントに含める必要があるモジュール、パッケージおよび型の要素を返します。
        戻り値:
        含まれる要素のセット

      • getDocTrees

        DocTrees getDocTrees()
        DocTreesユーティリティ・クラスのインスタンスを返します。 このクラスは、TreePathやDocCommentTreeなどにアクセスするためのメソッドを提供します。
        戻り値:
        ドキュメント・ツリーを操作するユーティリティ・クラス

      • getElementUtils

        Elements getElementUtils()
        Elementsユーティリティ・クラスのインスタンスを返します。 このクラスは、elementsで動作するメソッドを提供します。
        戻り値:
        要素を操作するユーティリティ・クラス

      • getTypeUtils

        Types getTypeUtils()
        Typesユーティリティ・クラスのインスタンスを返します。 このクラスは、type mirrorsで動作するメソッドを提供します。
        戻り値:
        タイプ・ミラーを操作するユーティリティ・クラス

      • isIncluded

        boolean isIncluded​(Element e)
        ドキュメントに要素を含める必要がある場合はtrueを返します。
        パラメータ:
        e - 要素
        戻り値:
        含まれる場合はtrue、そうでない場合はfalse

      • isSelected

        boolean isSelected​(Element e)
        要素が選択されている場合はtrueを返します。
        パラメータ:
        e - 要素
        戻り値:
        選択する場合はtrue、それ以外の場合はfalse

      • getJavaFileManager

        JavaFileManager getJavaFileManager()
        ファイルの読取りおよび書込みに使用するファイル・マネージャを返します。
        戻り値:
        ファイルの読取りおよび書込みに使用されるファイル・マネージャ

      • getSourceVersion

        SourceVersion getSourceVersion()
        読み取られたソース・ファイルのソース・バージョンを返します。
        戻り値:
        ソース・バージョン

      • getModuleMode

        DocletEnvironment.ModuleMode getModuleMode()
        モジュール・ドキュメントに必要なレベルを返します。
        戻り値:
        モジュール・ドキュメントに必要なレベル

      • getFileKind

        JavaFileObject.Kind getFileKind​(TypeElement type)
        型要素のファイルの種類を返します。
        パラメータ:
        type - 型要素
        戻り値:
        ファイルの種類