モジュール jdk.compiler
パッケージ com.sun.source.util

クラスDocTreePath

java.lang.Object
com.sun.source.util.DocTreePath
すべての実装されたインタフェース:
Iterable<DocTree>
public class DocTreePath extends Object implements Iterable<DocTree>
ツリー・ノードのパス。通常、最上位のDocCommentTreeノードまでのツリー・ノードの祖先ノードの順序を表すために使用されます。
導入されたバージョン:
1.8

  • コンストラクタの詳細

    • DocTreePath

      public DocTreePath​(TreePath treePath, DocCommentTree t)
      ルート・ノードのDocTreePathを作成します。
      パラメータ:
      treePath - ルート・ノードが作成されたTreePath
      t - パスを作成するDocCommentTree

    • DocTreePath

      public DocTreePath​(DocTreePath p, DocTree t)
      子ノードのDocTreePathを作成します。
      パラメータ:
      p - 親ノード
      t - 子ノード

  • メソッドの詳細

    • getPath

      public static DocTreePath getPath​(TreePath treePath, DocCommentTree doc, DocTree target)
      コンパイル単位内のツリー・ノードのドキュメント・ツリー・パスを返します。ノードが見つからない場合はnullを返します。
      パラメータ:
      treePath - docコメントが関連付けられているノードのパス
      doc - ノードに関連付けられたドキュメント・コメント
      target - docコメント内のノード
      戻り値:
      ツリー内のターゲットを識別するパス

    • getPath

      public static DocTreePath getPath​(DocTreePath path, DocTree target)
      DocTreePathオブジェクトで識別されるサブツリー内のツリー・ノードのドキュメント・ツリー・パスを返します。ノードが見つからない場合はnullを返します。
      パラメータ:
      path - docコメント・ツリー内のノードを識別するパス
      target - 指定されたノード内に配置されるノード
      戻り値:
      ターゲット・ノードを識別するパス

    • getTreePath

      public TreePath getTreePath()
      このパスに関連付けられたTreePathを返します。
      戻り値:
      このDocTreePathのTreePath

    • getDocComment

      public DocCommentTree getDocComment()
      このパスに関連付けられたDocCommentTreeを返します。
      戻り値:
      このDocTreePathのDocCommentTree

    • getLeaf

      public DocTree getLeaf()
      このパスのリーフ・ノードを返します。
      戻り値:
      このDocTreePathのDocTree

    • getParentPath

      public DocTreePath getParentPath()
      囲むノードのパスを返します。囲むノードがない場合はnullを返します。
      戻り値:
      親のDocTreePath

    • iterator

      public Iterator<DocTree> iterator()
      インタフェースからコピーされた説明: Iterable
      型Tの要素のイテレータを返します。
      定義:
      iterator、インタフェース: Iterable<DocTree>
      戻り値:
      イテレータ。