diff options
Diffstat (limited to 'BJC-Utils2/src/main/java/bjc/utils/data/ITree.java')
| -rw-r--r-- | BJC-Utils2/src/main/java/bjc/utils/data/ITree.java | 92 |
1 files changed, 41 insertions, 51 deletions
diff --git a/BJC-Utils2/src/main/java/bjc/utils/data/ITree.java b/BJC-Utils2/src/main/java/bjc/utils/data/ITree.java index 7d5988f..4b6725c 100644 --- a/BJC-Utils2/src/main/java/bjc/utils/data/ITree.java +++ b/BJC-Utils2/src/main/java/bjc/utils/data/ITree.java @@ -13,7 +13,7 @@ import bjc.utils.funcdata.bst.TreeLinearizationMethod; * * @author ben * @param <ContainedType> - * The type of data contained in the tree nodes + * The type of data contained in the tree nodes * */ public interface ITree<ContainedType> { @@ -21,7 +21,7 @@ public interface ITree<ContainedType> { * Add a child to this node * * @param child - * The child to add to this node + * The child to add to this node */ public void addChild(ITree<ContainedType> child); @@ -29,49 +29,46 @@ public interface ITree<ContainedType> { * Collapse a tree into a single version * * @param <NewType> - * The intermediate type being folded + * The intermediate type being folded * @param <ReturnedType> - * The type that is the end result + * The type that is the end result * @param leafTransform - * The function to use to convert leaf values + * The function to use to convert leaf values * @param nodeCollapser - * The function to use to convert internal nodes and their - * children + * The function to use to convert internal nodes and + * their children * @param resultTransformer - * The function to use to convert a state to the returned - * version + * The function to use to convert a state to the returned + * version * @return The final transformed state */ - public <NewType, ReturnedType> ReturnedType collapse( - Function<ContainedType, NewType> leafTransform, - Function<ContainedType, - Function<IList<NewType>, NewType>> nodeCollapser, + public <NewType, ReturnedType> ReturnedType collapse(Function<ContainedType, NewType> leafTransform, + Function<ContainedType, Function<IList<NewType>, NewType>> nodeCollapser, Function<NewType, ReturnedType> resultTransformer); /** * Execute a given action for each of this tree's children * * @param action - * The action to execute for each child + * The action to execute for each child */ void doForChildren(Consumer<ITree<ContainedType>> action); /** - * Expand the nodes of a tree into trees, and then merge the contents - * of those trees into a single tree + * Expand the nodes of a tree into trees, and then merge the contents of + * those trees into a single tree * * @param mapper - * The function to use to map values into trees + * The function to use to map values into trees * @return A tree, with some nodes expanded into trees */ - public ITree<ContainedType> flatMapTree( - Function<ContainedType, ITree<ContainedType>> mapper); + public ITree<ContainedType> flatMapTree(Function<ContainedType, ITree<ContainedType>> mapper); /** * Get the specified child of this tree * * @param childNo - * The number of the child to get + * The number of the child to get * @return The specified child of this tree */ default ITree<ContainedType> getChild(int childNo) { @@ -98,56 +95,52 @@ public interface ITree<ContainedType> { * Rebuild the tree with the same structure, but different nodes * * @param <MappedType> - * The type of the new tree + * The type of the new tree * @param leafTransformer - * The function to use to transform leaf tokens + * The function to use to transform leaf tokens * @param operatorTransformer - * The function to use to transform internal tokens + * The function to use to transform internal tokens * @return The tree, with the nodes changed */ - public <MappedType> ITree<MappedType> rebuildTree( - Function<ContainedType, MappedType> leafTransformer, + public <MappedType> ITree<MappedType> rebuildTree(Function<ContainedType, MappedType> leafTransformer, Function<ContainedType, MappedType> operatorTransformer); /** * Transform some of the nodes in this tree * * @param nodePicker - * The predicate to use to pick nodes to transform + * The predicate to use to pick nodes to transform * @param transformer - * The function to use to transform picked nodes + * The function to use to transform picked nodes */ - public void selectiveTransform(Predicate<ContainedType> nodePicker, - UnaryOperator<ContainedType> transformer); + public void selectiveTransform(Predicate<ContainedType> nodePicker, UnaryOperator<ContainedType> transformer); /** * Do a top-down transform of the tree * * @param transformPicker - * The function to use to pick how to progress + * The function to use to pick how to progress * @param transformer - * The function used to transform picked subtrees + * The function used to transform picked subtrees * @return The tree with the transform applied to picked subtrees */ - public ITree<ContainedType> topDownTransform( - Function<ContainedType, - TopDownTransformResult> transformPicker, + public ITree<ContainedType> topDownTransform(Function<ContainedType, TopDownTransformResult> transformPicker, UnaryOperator<ITree<ContainedType>> transformer); /** * Transform one of this nodes children * * @param <TransformedType> - * The type of the transformed value + * The type of the transformed value * @param childNo - * The number of the child to transform + * The number of the child to transform * @param transformer - * The function to use to transform the value + * The function to use to transform the value * @return The transformed value * * @throws IllegalArgumentException - * if the childNo is out of bounds (0 <= childNo <= - * childCount()) + * if the childNo is out of bounds (0 <= childNo <= + * childCount()) */ public <TransformedType> TransformedType transformChild(int childNo, Function<ITree<ContainedType>, TransformedType> transformer); @@ -156,34 +149,31 @@ public interface ITree<ContainedType> { * Transform the value that is the head of this node * * @param <TransformedType> - * The type of the transformed value + * The type of the transformed value * @param transformer - * The function to use to transform the value + * The function to use to transform the value * @return The transformed value */ - public <TransformedType> TransformedType transformHead( - Function<ContainedType, TransformedType> transformer); + public <TransformedType> TransformedType transformHead(Function<ContainedType, TransformedType> transformer); /** * Transform the tree into a tree with a different type of token * * @param <MappedType> - * The type of the new tree + * The type of the new tree * @param transformer - * The function to use to transform tokens + * The function to use to transform tokens * @return A tree with the token types transformed */ - public <MappedType> ITree<MappedType> transformTree( - Function<ContainedType, MappedType> transformer); + public <MappedType> ITree<MappedType> transformTree(Function<ContainedType, MappedType> transformer); /** * Perform an action on each part of the tree * * @param linearizationMethod - * The way to traverse the tree + * The way to traverse the tree * @param action - * The action to perform on each tree node + * The action to perform on each tree node */ - public void traverse(TreeLinearizationMethod linearizationMethod, - Consumer<ContainedType> action); + public void traverse(TreeLinearizationMethod linearizationMethod, Consumer<ContainedType> action); } |