Class DocTreePath
java.lang.Object
com.sun.source.util.DocTreePath
-
Constructor Summary
ConstructorsConstructorDescriptionDocTreePath(DocTreePath p, DocTree t) Creates aDocTreePathfor a child node.DocTreePath(TreePath treePath, DocCommentTree t) Creates aDocTreePathfor a root node. -
Method Summary
Modifier 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.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods declared in interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
DocTreePath
Creates aDocTreePathfor a root node.- Parameters:
treePath- theTreePathfrom which the root node was createdt- theDocCommentTreeto create the path for
-
DocTreePath
Creates aDocTreePathfor 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, ornullif 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 aDocTreePathobject, ornullif 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 theTreePathassociated with this path.- Returns:
- the
TreePathfor thisDocTreePath
-
getDocComment
Returns theDocCommentTreeassociated with this path.- Returns:
- the
DocCommentTreefor thisDocTreePath
-
getLeaf
Returns the leaf node for this path.- Returns:
- the
DocTreefor thisDocTreePath
-
getParentPath
Returns the path for the enclosing node, ornullif there is no enclosing node.- Returns:
DocTreePathof parent
-
iterator
-