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 SummaryConstructorsConstructorDescriptionDocTreePath(DocTreePath p, DocTree t) Creates aDocTreePathfor a child node.DocTreePath(TreePath treePath, DocCommentTree t) Creates aDocTreePathfor a root node.
- 
Method SummaryModifier and TypeMethodDescriptionReturns theDocCommentTreeassociated with this path.getLeaf()Returns the leaf node for this path.Returns the path for the enclosing node, ornullif there is no enclosing node.static DocTreePathgetPath(DocTreePath path, DocTree target) Returns a documentation tree path for a tree node within a subtree identified by aDocTreePathobject, ornullif the node is not found.static DocTreePathgetPath(TreePath treePath, DocCommentTree doc, DocTree target) Returns a documentation tree path for a tree node within a compilation unit, ornullif the node is not found.Returns theTreePathassociated with this path.iterator()Returns an iterator over elements of typeT.Methods declared in class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods declared in interface java.lang.IterableforEach, spliterator
- 
Constructor Details- 
DocTreePathCreates aDocTreePathfor a root node.- Parameters:
- treePath- the- TreePathfrom which the root node was created
- t- the- DocCommentTreeto create the path for
 
- 
DocTreePathCreates aDocTreePathfor a child node.- Parameters:
- p- the parent node
- t- the child node
 
 
- 
- 
Method Details- 
getPathReturns a documentation tree path for a tree node within a compilation unit, ornullif 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
 
- 
getPathReturns a documentation tree path for a tree node within a subtree identified by aDocTreePathobject, ornullif 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
 
- 
getTreePathReturns theTreePathassociated with this path.- Returns:
- the TreePathfor thisDocTreePath
 
- 
getDocCommentReturns theDocCommentTreeassociated with this path.- Returns:
- the DocCommentTreefor thisDocTreePath
 
- 
getLeafReturns the leaf node for this path.- Returns:
- the DocTreefor thisDocTreePath
 
- 
getParentPathReturns the path for the enclosing node, ornullif there is no enclosing node.- Returns:
- DocTreePathof parent
 
- 
iteratorDescription copied from interface:IterableReturns an iterator over elements of typeT.
 
-