java.lang.Object
com.sun.source.util.TreePath
public class TreePath extends Object implements Iterable<Tree>
A path of tree nodes, typically used to represent the sequence of ancestor
nodes of a tree node up to the top level CompilationUnitTree node.
- Since:
- 1.6
-
Constructor Summary
Constructors Constructor Description TreePath(CompilationUnitTree node)
Creates a TreePath for a root node.TreePath(TreePath path, Tree tree)
Creates a TreePath for a child node. -
Method Summary
Modifier and Type Method Description CompilationUnitTree
getCompilationUnit()
Returns the compilation unit associated with this path.Tree
getLeaf()
Returns the leaf node for this path.TreePath
getParentPath()
Returns the path for the enclosing node, ornull
if there is no enclosing node.static TreePath
getPath(CompilationUnitTree unit, Tree target)
Returns a tree path for a tree node within a compilation unit, ornull
if the node is not found.static TreePath
getPath(TreePath path, Tree target)
Returns a tree path for a tree node within a subtree identified by a TreePath object.Iterator<Tree>
iterator()
Iterates from leaves to root.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
-
TreePath
Creates a TreePath for a root node.- Parameters:
node
- the root node
-
TreePath
Creates a TreePath for a child node.- Parameters:
path
- the parent pathtree
- the child node
-
-
Method Details
-
getPath
Returns a tree path for a tree node within a compilation unit, ornull
if the node is not found.- Parameters:
unit
- the compilation unit to searchtarget
- the node to locate- Returns:
- the tree path
-
getPath
Returns a tree path for a tree node within a subtree identified by a TreePath object. Returnsnull
if the node is not found.- Parameters:
path
- the path in which to searchtarget
- the node to locate- Returns:
- the tree path of the target node
-
getCompilationUnit
Returns the compilation unit associated with this path.- Returns:
- the compilation unit
-
getLeaf
Returns the leaf node for this path.- Returns:
- the leaf node
-
getParentPath
Returns the path for the enclosing node, ornull
if there is no enclosing node.- Returns:
- the path for the enclosing node
-
iterator
Iterates from leaves to root.
-