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

インタフェースDocletEnvironment

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

  • メソッドの詳細

    • getSpecifiedElements

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

    • getIncludedElements

      Set<? extends Element> 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 - 型要素
      戻り値:
      ファイルの種類