クラスDocTrees

java.lang.Object
com.sun.source.util.Trees
com.sun.source.util.DocTrees
public abstract class DocTrees extends Trees
ドキュメンテーション・コメントの構文ツリーへのアクセスを提供します。
導入されたバージョン:
1.8

  • コンストラクタのサマリー

    コンストラクタ
    コンストラクタ
    説明
    DocTrees()
    サブクラスが呼び出すためのコンストラクタ。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    abstract BreakIterator
    getBreakIterator()
    ドキュメント・コメントの最初の文をコンピュートするために使用されるブレーク・イテレータを返します。
    abstract String
    getCharacters(EntityTree tree)
    指定されたエンティティ・ツリー内のエンティティの文字を含む文字列を返します。ツリーが有効な一連の文字を表していない場合はnullを返します。
    abstract Elements.DocCommentKind
    getDocCommentKind(TreePath path)
    ツリー・ノードに関連付けられたドキュメント・コメントのスタイルを返します。
    abstract DocCommentTree
    getDocCommentTree(TreePath path)
    指定されたTreePathで識別されるツリー・ノードのdocコメント・ツリー(ある場合)を返します。
    abstract DocCommentTree
    getDocCommentTree(Element e)
    指定された要素のdocコメント・ツリーを返します。
    abstract DocCommentTree
    getDocCommentTree(Element e, String relativePath)
    指定されたファイルのdocコメント・ツリーを返します。このツリーは、サポートされているファイル・タイプのいずれかであり、そのパスは指定された要素に対して相対的に指定されます。
    abstract DocCommentTree
    getDocCommentTree(FileObject fileObject)
    指定されたファイルのdocコメント・ツリーを返します。このツリーは、サポートされているファイル・タイプのいずれかである必要があります。
    abstract DocTreeFactory
    getDocTreeFactory()
    DocTreeオブジェクトを作成するためのユーティリティ・オブジェクトを返します。
    abstract DocTreePath
    getDocTreePath(FileObject fileObject, PackageElement packageElement)
    指定されたファイルのドキュメント・コメント・ツリーを含むドキュメント・ツリー・パスを返します。このパスは、サポートされているファイル・タイプのいずれかである必要があります。
    abstract Element
    getElement(DocTreePath path)
    指定されたDocTreePathのリーフ・ノードによって参照される言語モデル要素を返します。不明な場合はnullを返します。
    abstract List<DocTree>
    getFirstSentence(List<? extends DocTree> list)
    コメントの最初の文を表すDocTreeのリストを返します。
    abstract DocSourcePositions
    getSourcePositions()
    ドキュメント・ツリー・ノードのソース位置にアクセスするためのユーティリティ・オブジェクトを返します。
    abstract TypeMirror
    getType(DocTreePath path)
    指定されたDocTreePathのリーフ・ノードによって参照される言語モデル・タイプを返します。不明な場合はnullを返します。
    static DocTrees
    instance(ProcessingEnvironment env)
    指定されたProcessingEnvironmentのDocTreesオブジェクトを返します。
    static DocTrees
    instance(JavaCompiler.CompilationTask task)
    指定されたCompilationTaskのDocTreesオブジェクトを返します。
    abstract void
    printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root)
    指定されたコンパイル単位内のツリーの位置に、指定された種類のメッセージを出力します
    abstract void
    setBreakIterator(BreakIterator breakIterator)
    ブレーク・イテレータを設定して、ドキュメント・コメントの最初の文をコンピュートします。

    クラスツリーで宣言されたメソッド

    getDocComment, getElement, getLub, getOriginalType, getPath, getPath, getPath, getPath, getScope, getTree, getTree, getTree, getTree, getTree, getTypeMirror, isAccessible, isAccessible, printMessage
    修飾子と型
    メソッド
    説明
    abstract String
    getDocComment(TreePath path)
    指定されたTreePathで識別されるTreeノードのdocコメント(ある場合)を返します。
    abstract Element
    getElement(TreePath path)
    指定されたTreePathで識別されるTreeノードのElementを返します。
    abstract TypeMirror
    getLub(CatchTree tree)
    catch句で宣言された例外パラメータのlubを返します。
    abstract TypeMirror
    getOriginalType(ErrorType errorType)
    ErrorTypeオブジェクトから元のタイプを返します。
    abstract TreePath
    getPath(CompilationUnitTree unit, Tree node)
    指定されたコンパイル・ユニット内のツリー・ノードへのパスを返します。
    abstract TreePath
    getPath(Element e)
    指定されたElementのTreePathノードを返します。
    abstract TreePath
    getPath(Element e, AnnotationMirror a)
    指定されたElementのAnnotationMirrorのTreePathノードを返します。
    abstract TreePath
    getPath(Element e, AnnotationMirror a, AnnotationValue v)
    指定されたElementのAnnotationMirrorのAnnotationValueのTreePathノードを返します。
    abstract Scope
    getScope(TreePath path)
    指定されたTreePathで識別されるTreeノードのScopeを返します。
    abstract Tree
    getTree(Element element)
    指定されたElementのTreeノードを返します。
    abstract Tree
    getTree(Element e, AnnotationMirror a)
    指定されたElementのAnnotationMirrorのTreeノードを返します。
    abstract Tree
    getTree(Element e, AnnotationMirror a, AnnotationValue v)
    指定されたElementのAnnotationMirrorのAnnotationValueのTreeノードを返します。
    abstract MethodTree
    getTree(ExecutableElement method)
    指定されたExecutableElementのMethodTreeノードを返します。
    abstract ClassTree
    getTree(TypeElement element)
    指定されたTypeElementのClassTreeノードを返します。
    abstract TypeMirror
    getTypeMirror(TreePath path)
    指定されたTreePathで識別されるTreeノードのTypeMirrorを返します。
    abstract boolean
    isAccessible(Scope scope, Element member, DeclaredType type)
    指定されたスコープ内で、指定された要素が、指定された型のメンバーとしてアクセス可能であるかどうかを判定します。
    abstract boolean
    isAccessible(Scope scope, TypeElement type)
    指定されたスコープ内で、指定された型にアクセス可能であるかどうかを判定します。
    abstract void
    printMessage(Diagnostic.Kind kind, CharSequence msg, Tree t, CompilationUnitTree root)
    指定されたコンパイル単位内のツリーの位置に、指定された種類のメッセージを出力します

    クラスオブジェクトで宣言されたメソッド

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    修飾子と型
    メソッド
    説明
    protected Object
    clone()
    このオブジェクトのコピーを作成して、返します。
    boolean
    equals(Object obj)
    このオブジェクトと他のオブジェクトが等しいかどうかを示します。
    protected void
    finalize()
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    最終決定は非推奨であり、将来のリリースで削除される可能性があります。
    final Class<?>
    getClass()
    このObjectの実行時クラスを返します。
    int
    hashCode()
    このオブジェクトに対するハッシュ・コード値を返します。
    final void
    notify()
    このオブジェクトのモニターで待機中のスレッドを1つ再開します。
    final void
    notifyAll()
    このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
    String
    toString()
    オブジェクトの文字列表現を返します。
    final void
    wait()
    現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
    final void
    wait(long timeoutMillis)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
    final void
    wait(long timeoutMillis, int nanos)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

  • コンストラクタの詳細

    • DocTrees

      public DocTrees()
      サブクラスが呼び出すためのコンストラクタ。

  • メソッドの詳細

    • instance

      public static DocTrees instance(JavaCompiler.CompilationTask task)
      指定されたCompilationTaskのDocTreesオブジェクトを返します。
      パラメータ:
      task - Treesオブジェクトを取得するコンパイル・タスク
      戻り値:
      DocTreesオブジェクト
      スロー:
      IllegalArgumentException - タスクがTrees APIをサポートしていない場合。

    • instance

      public static DocTrees instance(ProcessingEnvironment env)
      指定されたProcessingEnvironmentのDocTreesオブジェクトを返します。
      パラメータ:
      env - Treesオブジェクトを取得する処理環境
      戻り値:
      DocTreesオブジェクト
      スロー:
      IllegalArgumentException - envがTrees APIをサポートしていない場合。

    • getBreakIterator

      public abstract BreakIterator getBreakIterator()
      ドキュメント・コメントの最初の文をコンピュートするために使用されるブレーク・イテレータを返します。 何も指定されていない場合は、nullを返します。
      戻り値:
      ブレーク・イテレータ
      導入されたバージョン:
      9

    • getDocCommentKind

      public abstract Elements.DocCommentKind getDocCommentKind(TreePath path)
      ツリー・ノードに関連付けられたドキュメント・コメントのスタイルを返します。
      パラメータ:
      path - ツリー・ノードのパス
      戻り値:
      ツリー・ノードに関連付けられたドキュメント・コメントのスタイル
      導入されたバージョン:
      23
      関連項目:

    • getDocCommentTree

      public abstract DocCommentTree getDocCommentTree(TreePath path)
      指定されたTreePathで識別されるツリー・ノードのdocコメント・ツリー(ある場合)を返します。 ドキュメント・コメントが見つからなかった場合、nullを返します。
      実装上のノート:
      このメソッドのデフォルト実装は、同じ引数を持つ繰返し呼出しに対して同じDocCommentTreeインスタンスを返します。
      パラメータ:
      path - ツリー・ノードのパス
      戻り値:
      docコメント・ツリー

    • getDocCommentTree

      public abstract DocCommentTree getDocCommentTree(Element e)
      指定された要素のdocコメント・ツリーを返します。 ドキュメント・コメントが見つからなかった場合、nullを返します。
      実装上のノート:
      このメソッドのデフォルト実装は、同じ引数を持つ繰返し呼出しに対して同じDocCommentTreeインスタンスを返します。
      パラメータ:
      e - ドキュメントが必要な要素
      戻り値:
      docコメント・ツリー
      導入されたバージョン:
      9

    • getDocCommentTree

      public abstract DocCommentTree getDocCommentTree(FileObject fileObject)
      指定されたファイルのdocコメント・ツリーを返します。このツリーは、サポートされているファイル・タイプのいずれかである必要があります。

      サポートされるファイル・タイプは、次のとおりです。

      • .htmlで終わるファイル名で識別されるHTMLファイル
      • マークダウン・ファイル。.mdで終わるファイル名で識別されます。
      将来のリリースでは、追加のファイル・タイプがサポートされる場合があります。

      実装上のノート:
      このメソッドのデフォルト実装は、起動ごとに新しいDocCommentTreeインスタンスを返します。
      パラメータ:
      fileObject - コンテンツ・コンテナ
      戻り値:
      docコメント・ツリー
      スロー:
      IllegalArgumentException - ファイル・タイプがサポートされていない場合
      導入されたバージョン:
      9

    • getDocCommentTree

      public abstract DocCommentTree getDocCommentTree(Element e, String relativePath) throws IOException
      指定されたファイルのdocコメント・ツリーを返します。このツリーは、サポートされているファイル・タイプのいずれかであり、そのパスは指定された要素に対して相対的に指定されます。

      サポートされるファイル・タイプは、次のとおりです。

      • .htmlで終わるファイル名で識別されるHTMLファイル
      • マークダウン・ファイル。.mdで終わるファイル名で識別されます。
      将来のリリースでは、追加のファイル・タイプがサポートされる場合があります。

      実装上のノート:
      このメソッドのデフォルト実装は、起動ごとに新しいDocCommentTreeインスタンスを返します。
      パラメータ:
      e - パスが参照として使用される要素
      relativePath - 要素からの相対パス
      戻り値:
      docコメント・ツリー
      スロー:
      IOException - 例外が発生した場合
      IllegalArgumentException - ファイル・タイプがサポートされていない場合
      導入されたバージョン:
      9

    • getDocTreePath

      public abstract DocTreePath getDocTreePath(FileObject fileObject, PackageElement packageElement)
      指定されたファイルのドキュメント・コメント・ツリーを含むドキュメント・ツリー・パスを返します。このパスは、サポートされているファイル・タイプのいずれかである必要があります。 サポートされているファイル・タイプは、HTMLファイルおよびマークダウン・ファイルです。 将来のリリースでは、追加のファイル・タイプがサポートされる場合があります。 docコメント・ツリーの@seeタグおよび{@link}タグに含まれるソース・コード要素への参照は、指定されたpackage要素のコンテキストで評価されます。 ドキュメント・コメントが見つからなかった場合、nullを返します。
      パラメータ:
      fileObject - HTMLコンテンツをカプセル化するファイル・オブジェクト
      packageElement - レガシーpackage.htmlを表す特定のファイル・オブジェクトに関連付けるパッケージ要素。それ以外の場合はnull
      戻り値:
      指定されたファイルから解析されたdocコメントを含むdocツリー・パス
      スロー:
      IllegalArgumentException - ファイル・タイプがサポートされていない場合
      導入されたバージョン:
      9

    • getElement

      public abstract Element getElement(DocTreePath path)
      指定されたDocTreePathのリーフ・ノードによって参照される言語モデル要素を返します。不明な場合はnullを返します。
      パラメータ:
      path - ツリー・ノードのパス
      戻り値:
      要素

    • getType

      public abstract TypeMirror getType(DocTreePath path)
      指定されたDocTreePathのリーフ・ノードによって参照される言語モデル・タイプを返します。不明な場合はnullを返します。 このメソッドは通常、getElement(DocTreePath)がnull以外の値を返すpath引数に対してgetElement(path).asType()と同じ値を返しますが、RAW型のかわりにパラメータ化された汎用型などの追加情報を含む型を返すことがあります。
      パラメータ:
      path - ツリー・ノードのパス
      戻り値:
      参照される型、またはnull
      導入されたバージョン:
      15

    • getFirstSentence

      public abstract List<DocTree> getFirstSentence(List<? extends DocTree> list)
      コメントの最初の文を表すDocTreeのリストを返します。
      パラメータ:
      list - 質問するDocTreeリスト
      戻り値:
      最初の文
      導入されたバージョン:
      9

    • getSourcePositions

      public abstract DocSourcePositions getSourcePositions()
      ドキュメント・ツリー・ノードのソース位置にアクセスするためのユーティリティ・オブジェクトを返します。
      定義:
      getSourcePositions、クラスTrees
      戻り値:
      ユーティリティ・オブジェクト

    • printMessage

      public abstract void printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root)
      指定されたコンパイル単位内のツリーの位置に、指定された種類のメッセージを出力します
      パラメータ:
      kind - メッセージの種類
      msg - メッセージ、ない場合は空の文字列
      t - 位置のヒントとして使用するツリー
      c - 位置ヒントとして使用するドキュメント・コメント・ツリー
      root - ツリーを格納するコンパイル・ユニット

    • setBreakIterator

      public abstract void setBreakIterator(BreakIterator breakIterator)
      ブレーク・イテレータを設定して、ドキュメント・コメントの最初の文をコンピュートします。
      パラメータ:
      breakIterator - ブレーク・イテレータまたはnullを使用して、デフォルトの文ブレーカを指定
      導入されたバージョン:
      9

    • getDocTreeFactory

      public abstract DocTreeFactory getDocTreeFactory()
      DocTreeオブジェクトを作成するためのユーティリティ・オブジェクトを返します。
      戻り値:
      DocTreeオブジェクトを作成するユーティリティ・オブジェクト
      導入されたバージョン:
      9

    • getCharacters

      public abstract String getCharacters(EntityTree tree)
      指定されたエンティティ・ツリー内のエンティティの文字を含む文字列を返します。ツリーが有効な一連の文字を表していない場合はnullを返します。

      エンティティの解釈は、HTML 5.2仕様のセクション「8.1.4.文字参照」に基づきます。

      パラメータ:
      tree - エンティティを含むツリー
      戻り値:
      文字を含む文字列
      導入されたバージョン:
      16
      外部仕様