モジュール 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(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を返します。

クラス java.lang.Objectで宣言されたメソッド

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

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

forEach, iterator, 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