Module jdk.compiler

软件包 com.sun.source.util

Class DocTreePath

java.lang.Object

com.sun.source.util.DocTreePath

All Implemented Interfaces:

Iterable<DocTree>

public class DocTreePath
extends Object
implements Iterable<DocTree>

树节点的路径，通常用于表示直到顶层DocCommentTree节点的树节点的祖先节点序列。

从以下版本开始：

1.8

构造方法摘要

构造方法

Constructor	描述
DocTreePath(DocTreePath p, DocTree t)	为子节点创建DocTreePath。
DocTreePath(TreePath treePath, DocCommentTree t)	为根节点创建DocTreePath。

方法摘要

Modifier and Type	方法	描述
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元素的迭代器。

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

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

构造方法详细信息

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 - 与节点相关联的文档注释

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元素的迭代器。

Specified by:

iterator在接口 Iterable<DocTree>

结果

一个迭代器