Class 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.

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.

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, or `null` 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, or `null` 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.

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

forEach, spliterator

public TreePath(CompilationUnitTree node)

Creates a TreePath for a root node.

public TreePath(TreePath path,
                Tree tree)

Creates a TreePath for a child node.

public static TreePath getPath(CompilationUnitTree unit,
                               Tree target)

Returns a tree path for a tree node within a compilation unit, or null if the node is not found.

Parameters:: unit - the compilation unit to search; target - the node to locate
Returns:: the tree path

public static TreePath getPath(TreePath path,
                               Tree target)

Returns a tree path for a tree node within a subtree identified by a TreePath object. Returns null if the node is not found.

Parameters:: path - the path in which to search; target - the node to locate
Returns:: the tree path of the target node

public CompilationUnitTree getCompilationUnit()

Returns the compilation unit associated with this path.

public Tree getLeaf()

Returns the leaf node for this path.

public TreePath getParentPath()

Returns the path for the enclosing node, or null if there is no enclosing node.

public Iterator<Tree> iterator()

Iterates from leaves to root.