クラスDocTreePath

java.lang.Object

com.sun.source.util.DocTreePath

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

Iterable<DocTree>

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オブジェクトで識別されるサブツリー内のツリー・ノードのドキュメント・ツリー・パスを返します。ノードが見つからない場合はnullを返します。
static DocTreePath	getPath(TreePath treePath, DocCommentTree doc, DocTree target)	コンパイル・ユニット内のツリー・ノードのドキュメント・ツリー・パス、またはノードが見つからない場合はnullを返します。
TreePath	getTreePath()	このパスに関連付けられたTreePathを返します。
Iterator<DocTree>	iterator()	型Tの要素のイテレータを返します。

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

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であるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

インタフェースIterableで宣言されたメソッド

forEach, spliterator

修飾子と型	メソッド	説明
default void	forEach(Consumer<? super DocTree> action)	Iterableの各要素に対して指定されたアクションを、すべての要素が処理されるか、アクションが例外をスローするまで実行します。
default Spliterator<DocTree>	spliterator()	このIterableによって記述される要素に対するSpliteratorを作成します。

コンストラクタの詳細

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>

戻り値:

イテレータ。