com.sun.source.util

クラスDocTreePath

java.lang.Object

com.sun.source.util.DocTreePath

すべての実装されたインタフェース:

Iterable<DocTree>

@Exported
public class DocTreePath
extends Object
implements Iterable<DocTree>

ツリー・ノードのパスです。通常、トップ・レベルのDocCommentTreeノードまでの、ツリー・ノードの上位ノードのシーケンスを表すために使用されます。

導入されたバージョン:

1.8

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

コンストラクタ

コンストラクタと説明
DocTreePath(DocTreePath p, DocTree t) 子ノードのDocTreePathを作成します。
DocTreePath(TreePath treePath, DocCommentTree t) ルート・ノードのDocTreePathを作成します。

メソッドのサマリー

修飾子と型	メソッドと説明
DocCommentTree	getDocComment() このパスに関連付けられたDocCommentTreeを取得します。
DocTree	getLeaf() このパスの葉ノードを取得します。
DocTreePath	getParentPath() 包含するノードのパスを取得します。包含するノードがない場合は、nullを返します。
static DocTreePath	getPath(DocTreePath path, DocTree target) DocTreePathオブジェクトによって識別されるサブツリー内のツリー・ノードのドキュメンテーション・ツリー・パスを取得します。
static DocTreePath	getPath(TreePath treePath, DocCommentTree doc, DocTree target) コンパイル・ユニット内のツリー・ノードのドキュメンテーション・ツリー・パスを取得します。
TreePath	getTreePath() このパスに関連付けられたTreePathを取得します。
Iterator<DocTree>	iterator() 型Tの要素のイテレータを返します。

クラス java.lang.Objectから継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェース java.lang.Iterableから継承されたメソッド

forEach, spliterator

コンストラクタの詳細

DocTreePath

public DocTreePath(TreePath treePath,
                   DocCommentTree t)

ルート・ノードのDocTreePathを作成します。

パラメータ:

treePath - ルート・ノードが作成されたTreePath。

t - パスを作成するDocCommentTree。

DocTreePath

public DocTreePath(DocTreePath p,
                   DocTree t)

子ノードのDocTreePathを作成します。

メソッドの詳細

getPath

public static DocTreePath getPath(TreePath treePath,
                                  DocCommentTree doc,
                                  DocTree target)

コンパイル・ユニット内のツリー・ノードのドキュメンテーション・ツリー・パスを取得します。

戻り値:

ノードが見つからない場合はnull

getPath

public static DocTreePath getPath(DocTreePath path,
                                  DocTree target)

DocTreePathオブジェクトによって識別されるサブツリー内のツリー・ノードのドキュメンテーション・ツリー・パスを取得します。

戻り値:

ノードが見つからない場合はnull

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()

次のインタフェースからコピーされた説明: java.lang.Iterable

型Tの要素のイテレータを返します。

定義:

iterator、インタフェース: Iterable<DocTree>

戻り値:

イテレータ。