com.diffplug.common.tree

Class TreeQuery

java.lang.Object

com.diffplug.common.tree.TreeQuery

public final class TreeQuery
extends Object

Queries against TreeDef trees, such as lowest common ancestor, list of parents, etc.

Method Summary

Modifier and Type	Method and Description
static <T,CopyType> CopyType	copyLeavesIn(TreeDef<T> def, T root, BiFunction<T,List<CopyType>,CopyType> nodeMapper) Copies the given tree of T to CopyType, starting at the leaf nodes of the tree and moving in to the root node, which allows CopyType to be immutable (but does not require it).
static <T,CopyType> CopyType	copyRootOut(TreeDef<T> def, T root, BiFunction<T,CopyType,CopyType> mapper) Copies the given tree of T to CopyType, starting at the root node of the tree and moving out to the leaf nodes, which generally requires CopyType to be mutable (if you want CopyType nodes to know who their children are).
static <T,P> Optional<T>	findByPath(TreeDef<T> treeDef, T node, Function<? super T,?> treeMapper, List<P> path, Function<? super P,?> pathMapper) Finds a child TreeNode based on its path.
static <T,P> Optional<T>	findByPath(TreeDef<T> treeDef, T node, List<P> path, BiPredicate<T,P> equality) Finds a child TreeNode based on its path.
static <T> Optional<T>	findByPath(TreeDef<T> treeDef, T node, List<T> path, Function<? super T,?> mapper) Finds a child TreeNode based on its path.
static <T> boolean	isDescendantOf(TreeDef.Parented<T> treeDef, T child, T parent) Returns true iff child is a descendant of parent.
static <T> boolean	isDescendantOfOrEqualTo(TreeDef.Parented<T> treeDef, T child, T parent) Returns true iff child is a descendant of parent, or if child is equal to parent.
static <T> Optional<T>	lowestCommonAncestor(TreeDef.Parented<T> treeDef, List<T> nodes) Returns the common parent of N elements.
static <T> Optional<T>	lowestCommonAncestor(TreeDef.Parented<T> treeDef, T... nodes) Returns the common parent of N elements.
static <T> String	path(TreeDef.Parented<T> treeDef, T node) Returns the path of the given node, using / as the path delimiter and Object.toString() as the mapping function.
static <T> String	path(TreeDef.Parented<T> treeDef, T node, Function<? super T,String> toString) Returns the path of the given node, using / as the path delimiter.
static <T> String	path(TreeDef.Parented<T> treeDef, T node, Function<? super T,String> toString, String delimiter) Returns the path of the given node.
static <T> T	root(TreeDef.Parented<T> treeDef, T node) Returns the root of the given tree.
static <T> List<T>	toParent(TreeDef.Parented<T> treeDef, T node, T parent) Creates a mutable list whose first element is node, and last element is parent.
static <T> List<T>	toRoot(TreeDef.Parented<T> treeDef, T node) Creates a mutable list whose first element is node, and last element is its root parent.
static <T> String	toString(TreeDef<T> treeDef, T root) Converts the entire tree into a string-based representation.
static <T> String	toString(TreeDef<T> treeDef, T root, Function<? super T,String> toString) Converts the entire tree into a string-based representation.
static <T> String	toString(TreeDef<T> treeDef, T root, Function<? super T,String> toString, String indent) Converts the entire tree into a string-based representation.

Methods inherited from class java.lang.Object

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

Method Detail

isDescendantOf

public static <T> boolean isDescendantOf(TreeDef.Parented<T> treeDef,
                                         T child,
                                         T parent)

Returns true iff child is a descendant of parent.

isDescendantOfOrEqualTo

public static <T> boolean isDescendantOfOrEqualTo(TreeDef.Parented<T> treeDef,
                                                  T child,
                                                  T parent)

Returns true iff child is a descendant of parent, or if child is equal to parent.

root

public static <T> T root(TreeDef.Parented<T> treeDef,
                         T node)

Returns the root of the given tree.

toRoot

public static <T> List<T> toRoot(TreeDef.Parented<T> treeDef,
                                 T node)

Creates a mutable list whose first element is node, and last element is its root parent.

copyLeavesIn

public static <T,CopyType> CopyType copyLeavesIn(TreeDef<T> def,
                                                 T root,
                                                 BiFunction<T,List<CopyType>,CopyType> nodeMapper)

Copies the given tree of T to CopyType, starting at the leaf nodes of the tree and moving in to the root node, which allows CopyType to be immutable (but does not require it).

Parameters:

def - defines the structure of the tree

root - root of the tree

nodeMapper - given an unmapped node, and a list of CopyType nodes which have already been mapped, return a mapped node.

Returns:

a CopyType with the same contents as the source tree

copyRootOut

public static <T,CopyType> CopyType copyRootOut(TreeDef<T> def,
                                                T root,
                                                BiFunction<T,CopyType,CopyType> mapper)

Copies the given tree of T to CopyType, starting at the root node of the tree and moving out to the leaf nodes, which generally requires CopyType to be mutable (if you want CopyType nodes to know who their children are).

Parameters:

def - defines the structure of the tree

root - root of the tree

nodeMapper - given an unmapped node, and a parent CopyType which has already been mapped, return a mapped node. This function must have the side effect that the returned node should be added as a child of its parent node.

Returns:

a CopyType with the same contents as the source tree

toParent

public static <T> List<T> toParent(TreeDef.Parented<T> treeDef,
                                   T node,
                                   T parent)

Creates a mutable list whose first element is node, and last element is parent.

Throws:

IllegalArgumentException - if parent is not a parent of node

lowestCommonAncestor

@SafeVarargs
public static <T> Optional<T> lowestCommonAncestor(TreeDef.Parented<T> treeDef,
                                                                T... nodes)

Returns the common parent of N elements.

lowestCommonAncestor

public static <T> Optional<T> lowestCommonAncestor(TreeDef.Parented<T> treeDef,
                                                   List<T> nodes)

Returns the common parent of N elements.

path

public static <T> String path(TreeDef.Parented<T> treeDef,
                              T node,
                              Function<? super T,String> toString,
                              String delimiter)

Returns the path of the given node.

Parameters:

treeDef - the treeDef

node - the root of the tree

toString - a function to map each node to a string in the path

delimiter - a string to use as a path separator

path

public static <T> String path(TreeDef.Parented<T> treeDef,
                              T node,
                              Function<? super T,String> toString)

Returns the path of the given node, using / as the path delimiter.

See Also:

path(com.diffplug.common.tree.TreeDef.Parented, Object, Function, String)

path

public static <T> String path(TreeDef.Parented<T> treeDef,
                              T node)

Returns the path of the given node, using / as the path delimiter and Object.toString() as the mapping function.

See Also:

path(com.diffplug.common.tree.TreeDef.Parented, Object, Function, String)

findByPath

public static <T,P> Optional<T> findByPath(TreeDef<T> treeDef,
                                           T node,
                                           List<P> path,
                                           BiPredicate<T,P> equality)

Finds a child TreeNode based on its path.

Searches the child nodes for the first element, then that node’s children for the second element, etc.

Parameters:

treeDef - defines a tree

node - starting point for the search

path - the path of nodes which we’re looking

equality - a function for determining equality between the tree nodes and the path elements

findByPath

public static <T,P> Optional<T> findByPath(TreeDef<T> treeDef,
                                           T node,
                                           Function<? super T,?> treeMapper,
                                           List<P> path,
                                           Function<? super P,?> pathMapper)

Finds a child TreeNode based on its path.

Searches the child nodes for the first element, then that node’s children for the second element, etc.

Parameters:

treeDef - defines a tree

node - starting point for the search

treeMapper - maps elements in the tree to some value for comparison with the path elements

path - the path of nodes which we’re looking

pathMapper - maps elements in the path to some value for comparison with the tree elements

findByPath

public static <T> Optional<T> findByPath(TreeDef<T> treeDef,
                                         T node,
                                         List<T> path,
                                         Function<? super T,?> mapper)

Finds a child TreeNode based on its path.

Searches the child nodes for the first element, then that node’s children for the second element, etc.

Parameters:

treeDef - defines a tree

node - starting point for the search

path - the path of nodes which we’re looking

mapper - maps elements to some value for comparison between the tree and the path

toString

public static <T> String toString(TreeDef<T> treeDef,
                                  T root)

Converts the entire tree into a string-based representation.

See Also:

toString(TreeDef, Object, Function, String)

toString

public static <T> String toString(TreeDef<T> treeDef,
                                  T root,
                                  Function<? super T,String> toString)

Converts the entire tree into a string-based representation.

See Also:

toString(TreeDef, Object, Function, String)

toString

public static <T> String toString(TreeDef<T> treeDef,
                                  T root,
                                  Function<? super T,String> toString,
                                  String indent)

Converts the entire tree into a string-based representation.

Parameters:

treeDef - the treeDef

root - the root of the tree

toString - the function which generates the name for each node in the tree

indent - the string to use for each level of indentation