From 946cab444bc301d8a7c756a1bab039558288de89 Mon Sep 17 00:00:00 2001
From: "Benjamin J. Culkin" <bjculkin@mix.wvu.edu>
Date: Wed, 11 Oct 2017 13:41:07 -0300
Subject: Cleanup work

---
 .../java/bjc/utils/funcdata/bst/ITreePart.java     | 70 +++++++++++++---------
 1 file changed, 42 insertions(+), 28 deletions(-)

(limited to 'base/src/main/java/bjc/utils/funcdata/bst/ITreePart.java')

diff --git a/base/src/main/java/bjc/utils/funcdata/bst/ITreePart.java b/base/src/main/java/bjc/utils/funcdata/bst/ITreePart.java
index 3aa8880..a2ce71f 100644
--- a/base/src/main/java/bjc/utils/funcdata/bst/ITreePart.java
+++ b/base/src/main/java/bjc/utils/funcdata/bst/ITreePart.java
@@ -11,53 +11,61 @@ import java.util.function.Predicate;
  * @author ben
  *
  * @param <T>
- *                The data contained in this part of the tree.
+ * 	The data contained in this part of the tree.
  */
 public interface ITreePart<T> {
 	/**
 	 * Add a element below this tree part somewhere.
 	 *
 	 * @param element
-	 *                The element to add below this tree part
+	 * 	The element to add below this tree part
+	 *
 	 * @param comparator
-	 *                The thing to use for comparing values to find where to
-	 *                insert the tree part.
+	 * 	The thing to use for comparing values to find where to
+	 * 	insert the tree part.
 	 */
 	public void add(T element, Comparator<T> comparator);
 
 	/**
-	 * Collapses this tree part into a single value. Does not change the
-	 * underlying tree.
+	 * Collapses this tree part into a single value.
+	 *
+	 * Does not change the underlying tree.
 	 *
 	 * @param <E>
-	 *                The type of the final collapsed value
+	 * 	The type of the final collapsed value
 	 *
 	 * @param nodeCollapser
-	 *                The function to use to transform data into mapped
-	 *                form.
+	 * 	The function to use to transform data into mapped form.
+	 *
 	 * @param branchCollapser
-	 *                The function to use to collapse data in mapped form
-	 *                into a single value.
-	 * @return A single value from collapsing the tree.
+	 * 	The function to use to collapse data in mapped form into a
+	 * 	single value.
+	 *
+	 * @return
+	 * 	A single value from collapsing the tree.
 	 */
 	public <E> E collapse(Function<T, E> nodeCollapser, BiFunction<E, E, E> branchCollapser);
 
 	/**
-	 * Check if this tre part or below it contains the specified data item
+	 * Check if this tre part or below it contains the specified data item.
 	 *
 	 * @param element
-	 *                The data item to look for.
+	 * 	The data item to look for.
+	 *
 	 * @param comparator
-	 *                The comparator to use to search for the data item
-	 * @return Whether or not the given item is contained in this tree part
-	 *         or its children.
+	 * 	The comparator to use to search for the data item.
+	 *
+	 * @return
+	 * 	Whether or not the given item is contained in this tree part or
+	 * 	its children.
 	 */
 	public boolean contains(T element, Comparator<T> comparator);
 
 	/**
 	 * Get the data associated with this tree part.
 	 *
-	 * @return The data associated with this tree part.
+	 * @return
+	 * 	The data associated with this tree part.
 	 */
 	public T data();
 
@@ -65,9 +73,10 @@ public interface ITreePart<T> {
 	 * Remove the given node from this tree part and any of its children.
 	 *
 	 * @param element
-	 *                The data item to remove.
+	 * 	The data item to remove.
+	 *
 	 * @param comparator
-	 *                The comparator to use to search for the data item.
+	 * 	The comparator to use to search for the data item.
 	 */
 	public void delete(T element, Comparator<T> comparator);
 
@@ -75,22 +84,27 @@ public interface ITreePart<T> {
 	 * Execute a directed walk through the tree.
 	 *
 	 * @param walker
-	 *                The function to use to direct the walk through the
-	 *                tree.
-	 * @return Whether the directed walk finished successfully.
+	 * 	The function to use to direct the walk through the
+	 * 	tree.
+	 *
+	 * @return
+	 * 	Whether the directed walk finished successfully.
 	 */
 	public boolean directedWalk(DirectedWalkFunction<T> walker);
 
 	/**
 	 * Execute a provided function for each element of tree it succesfully
-	 * completes for
+	 * completes for.
 	 *
 	 * @param linearizationMethod
-	 *                The way to linearize the tree for executing
+	 * 	The way to linearize the tree for executing.
+	 *
 	 * @param predicate
-	 *                The predicate to apply to each element, where it
-	 *                returning false terminates traversal early
-	 * @return Whether the traversal finished succesfully
+	 * 	The predicate to apply to each element, where it returning false
+	 * 	terminates traversal early.
+	 *
+	 * @return
+	 * 	Whether the traversal finished succesfully.
 	 */
 	public boolean forEach(TreeLinearizationMethod linearizationMethod, Predicate<T> predicate);
 }
-- 
cgit v1.2.3