- java.lang.Object
- 
- com.sun.source.util.DocTreePath
 
- 
- 
Constructor SummaryConstructors Constructor Description DocTreePath(DocTreePath p, DocTree t)Creates a DocTreePath for a child node.DocTreePath(TreePath treePath, DocCommentTree t)Creates a DocTreePath for a root node.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DocCommentTreegetDocComment()Returns the DocCommentTree associated with this path.DocTreegetLeaf()Returns the leaf node for this path.DocTreePathgetParentPath()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 a DocTreePath object, 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.TreePathgetTreePath()Returns the TreePath associated with this path.- 
Methods declared in class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods declared in interface java.lang.IterableforEach, iterator, spliterator
 
- 
 
- 
- 
- 
Constructor Detail- 
DocTreePathpublic DocTreePath(TreePath treePath, DocCommentTree t) Creates a DocTreePath for a root node.- Parameters:
- treePath- the TreePath from which the root node was created.
- t- the DocCommentTree to create the path for.
 
 - 
DocTreePathpublic DocTreePath(DocTreePath p, DocTree t) Creates a DocTreePath for a child node.- Parameters:
- p- the parent node
- t- the child node
 
 
- 
 - 
Method Detail- 
getPathpublic static DocTreePath getPath(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.- 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
 
 - 
getPathpublic static DocTreePath getPath(DocTreePath path, DocTree target) Returns a documentation tree path for a tree node within a subtree identified by a DocTreePath object, 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
 
 - 
getTreePathpublic TreePath getTreePath() Returns the TreePath associated with this path.- Returns:
- the TreePath for this DocTreePath
 
 - 
getDocCommentpublic DocCommentTree getDocComment() Returns the DocCommentTree associated with this path.- Returns:
- the DocCommentTree for this DocTreePath
 
 - 
getLeafpublic DocTree getLeaf() Returns the leaf node for this path.- Returns:
- the DocTree for this DocTreePath
 
 - 
getParentPathpublic DocTreePath getParentPath() Returns the path for the enclosing node, ornullif there is no enclosing node.- Returns:
- DocTreePath of parent
 
 
- 
 
-