org.lsst.ccs.framework

Class TreeWalkerUtils

java.lang.Object

org.lsst.ccs.framework.TreeWalkerUtils

public class TreeWalkerUtils
extends Object

A Utility class for navigating the Components Tree Structure.

Author:

The LSST CCS Team

Constructor Summary

Constructors

Constructor and Description
TreeWalkerUtils()

Method Summary

Modifier and Type	Method and Description
static void	proceduralNodeWalk(ComponentLookup lookup, String startingNodeName, Consumer<ComponentNode> pre, Consumer<ComponentNode> post) Full tree walking of the component node targeted on the node itself.
static <A> void	proceduralWalk(ComponentLookup lookup, String startingNodeName, Class<A> klass, Consumer<A> pre, Consumer<A> post) Full Tree walking method targeted on the node's inner object.
static void	treeNodeWalk(ComponentLookup lookup, String startingNodeName, Function<ComponentNode,TreeWalkerDiag> func, Consumer<ComponentNode> post) Walks the components tree recursively, applying rules of TreeWalkerDiag (the walk can be interrupted by HANDLING_CHILDREN (the code is not invoked on children) or STOP (the code abruptly ends) on the node itself.
static <J> void	treeWalk(ComponentLookup lookup, String startingNodeName, Class<J> klass, Function<J,TreeWalkerDiag> func, Consumer<J> post) Walks the components tree recursively, applying rules of TreeWalkerDiag (the walk can be interrupted by HANDLING_CHILDREN (the code is not invoked on children) or STOP (the code abruptly ends) on the node's inner component.

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeWalkerUtils

public TreeWalkerUtils()

Method Detail

proceduralWalk

public static <A> void proceduralWalk(ComponentLookup lookup,
                                      String startingNodeName,
                                      Class<A> klass,
                                      Consumer<A> pre,
                                      Consumer<A> post)

Full Tree walking method targeted on the node's inner object. If the class of the node's inner object is assignable to the specified class, the pre and post consumers are applied to it.

Type Parameters:

A - the type of the target node

Parameters:

lookup -

startingNodeName - the name of the node to start the procedure from.

klass -

pre - the procedure to apply in pre order

post - the procedure to apply in post order

proceduralNodeWalk

public static void proceduralNodeWalk(ComponentLookup lookup,
                                      String startingNodeName,
                                      Consumer<ComponentNode> pre,
                                      Consumer<ComponentNode> post)

Full tree walking of the component node targeted on the node itself.

Parameters:

lookup -

startingNodeName -

pre -

post -

treeWalk

public static <J> void treeWalk(ComponentLookup lookup,
                                String startingNodeName,
                                Class<J> klass,
                                Function<J,TreeWalkerDiag> func,
                                Consumer<J> post)

Walks the components tree recursively, applying rules of TreeWalkerDiag (the walk can be interrupted by HANDLING_CHILDREN (the code is not invoked on children) or STOP (the code abruptly ends) on the node's inner component.

Type Parameters:

J - the type of node

Parameters:

lookup -

startingNodeName -

klass -

func -

post -

treeNodeWalk

public static void treeNodeWalk(ComponentLookup lookup,
                                String startingNodeName,
                                Function<ComponentNode,TreeWalkerDiag> func,
                                Consumer<ComponentNode> post)

Walks the components tree recursively, applying rules of TreeWalkerDiag (the walk can be interrupted by HANDLING_CHILDREN (the code is not invoked on children) or STOP (the code abruptly ends) on the node itself.

Parameters:

lookup -

startingNodeName - the starting node

func -

post -