-
- All Implemented Interfaces:
Iterable<DocTree>
public class DocTreePath
extends Object
implements Iterable<DocTree>
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
-
-
Method Summary
-
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
getPath
public static DocTreePath getPath(TreePath treePath,
DocCommentTree doc,
DocTree target)
Returns a documentation tree path for a tree node within a compilation unit,
or null
if the node is not found.
- Parameters:
treePath
- the path for the node with which the doc comment is associated
doc
- the doc comment associated with the node
target
- a node within the doc comment
- Returns:
- a path identifying the target within the tree
-
getPath
public static DocTreePath getPath(DocTreePath path,
DocTree target)
Returns a documentation tree path for a tree node within a subtree
identified by a DocTreePath object, or null
if the node is not found.
- Parameters:
path
- a path identifying a node within a doc comment tree
target
- a node to be located within the given node
- Returns:
- a path identifying the target node
-
getParentPath
public DocTreePath getParentPath()
Returns the path for the enclosing node, or null
if there is no enclosing node.
- Returns:
- DocTreePath of parent