com.diffplug.common.base

Class TreeQuery

java.lang.Object

com.diffplug.common.base.TreeQuery

public class TreeQuery
extends Object

Queries against TreeDef trees, e.g. lowest common ancestor, list of parents, etc.

Constructor Summary

Constructors

Constructor and Description
TreeQuery()

Method Summary

Modifier and Type	Method and Description
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> 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> 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

Constructor Detail

TreeQuery

public TreeQuery()

Method Detail

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.

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