java.lang.Object
com.sun.source.util.DocTreePath
A path of tree nodes, typically used to represent the sequence of ancestor
nodes of a tree node up to the top-level
DocCommentTree
node.- Since:
- 1.8
-
Constructor Summary
ConstructorDescriptionDocTreePath
(DocTreePath p, DocTree t) Creates aDocTreePath
for a child node.DocTreePath
(TreePath treePath, DocCommentTree t) Creates aDocTreePath
for a root node. -
Method Summary
Modifier and TypeMethodDescriptionReturns theDocCommentTree
associated with this path.getLeaf()
Returns the leaf node for this path.Returns the path for the enclosing node, ornull
if there is no enclosing node.static DocTreePath
getPath
(DocTreePath path, DocTree target) Returns a documentation tree path for a tree node within a subtree identified by aDocTreePath
object, ornull
if the node is not found.static DocTreePath
getPath
(TreePath treePath, DocCommentTree doc, DocTree target) Returns a documentation tree path for a tree node within a compilation unit, ornull
if the node is not found.Returns theTreePath
associated with this path.iterator()
Returns an iterator over elements of typeT
.Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods declared in interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
DocTreePath
Creates aDocTreePath
for a root node.- Parameters:
treePath
- theTreePath
from which the root node was createdt
- theDocCommentTree
to create the path for
-
DocTreePath
Creates aDocTreePath
for a child node.- Parameters:
p
- the parent nodet
- the child node
-
-
Method Details
-
getPath
Returns a documentation tree path for a tree node within a compilation unit, ornull
if the node is not found.- Parameters:
treePath
- the path for the node with which the doc comment is associateddoc
- the doc comment associated with the nodetarget
- a node within the doc comment- Returns:
- a path identifying the target within the tree
-
getPath
Returns a documentation tree path for a tree node within a subtree identified by aDocTreePath
object, ornull
if the node is not found.- Parameters:
path
- a path identifying a node within a doc comment treetarget
- a node to be located within the given node- Returns:
- a path identifying the target node
-
getTreePath
Returns theTreePath
associated with this path.- Returns:
- the
TreePath
for thisDocTreePath
-
getDocComment
Returns theDocCommentTree
associated with this path.- Returns:
- the
DocCommentTree
for thisDocTreePath
-
getLeaf
Returns the leaf node for this path.- Returns:
- the
DocTree
for thisDocTreePath
-
getParentPath
Returns the path for the enclosing node, ornull
if there is no enclosing node.- Returns:
DocTreePath
of parent
-
iterator
Description copied from interface:Iterable
Returns an iterator over elements of typeT
.
-