org.oakgp.node.walk

Class NodeWalk

java.lang.Object

org.oakgp.node.walk.NodeWalk

public final class NodeWalk
extends Object

Provides a mechanism for recursively visiting all nodes in a tree structure.

Method Summary

Modifier and Type	Method and Description
static Node	getAt(Node node, int index) Returns a Node from the tree structure represented by the given Node.
static Node	replaceAll(Node node, Predicate<Node> criteria, Function<Node,Node> replacement) Returns a new Node resulting from replacing any components that match the specified predicate with the result of applying the specified function.
static Node	replaceAt(Node node, int index, Function<Node,Node> replacement) Returns a new Node resulting from replacing the Node at position index of the given Node with the result of replacement.

Methods inherited from class java.lang.Object

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

Method Detail

getAt

public static Node getAt(Node node,
                         int index)

Returns a Node from the tree structure represented by the given Node.

Parameters:

index - the index of the Node, in the tree structure represented by node, that needs to be returned

Returns:

the Node at index of the tree structure represented by node

replaceAt

public static Node replaceAt(Node node,
                             int index,
                             Function<Node,Node> replacement)

Returns a new Node resulting from replacing the Node at position index of the given Node with the result of replacement.

Parameters:

index - the index of the Node, in the tree structure represented by node, that needs to be replaced

replacement - the function to apply to the Node at index to determine the Node that should replace it

Returns:

a new Node derived from replacing the Node at index with the result of replacement

replaceAll

public static Node replaceAll(Node node,
                              Predicate<Node> criteria,
                              Function<Node,Node> replacement)

Returns a new Node resulting from replacing any components that match the specified predicate with the result of applying the specified function.

Parameters:

criteria - the predicate used to determine if a node should be replaced

replacement - the function used to determine what a node should be replaced with