summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/funcdata/bst/DirectedWalkFunction.java
diff options
context:
space:
mode:
authorBenjamin J. Culkin <bjculkin@mix.wvu.edu>2017-10-11 13:41:07 -0300
committerBenjamin J. Culkin <bjculkin@mix.wvu.edu>2017-10-11 13:41:07 -0300
commit946cab444bc301d8a7c756a1bab039558288de89 (patch)
tree419f27c39a509bcd83cae0e6630be8eb7ff95a30 /base/src/main/java/bjc/utils/funcdata/bst/DirectedWalkFunction.java
parentc82e3b3b2de0633317ec8fc85925e91422820597 (diff)
Cleanup work
Diffstat (limited to 'base/src/main/java/bjc/utils/funcdata/bst/DirectedWalkFunction.java')
-rw-r--r--base/src/main/java/bjc/utils/funcdata/bst/DirectedWalkFunction.java18
1 files changed, 7 insertions, 11 deletions
diff --git a/base/src/main/java/bjc/utils/funcdata/bst/DirectedWalkFunction.java b/base/src/main/java/bjc/utils/funcdata/bst/DirectedWalkFunction.java
index e11524a..fdf86d7 100644
--- a/base/src/main/java/bjc/utils/funcdata/bst/DirectedWalkFunction.java
+++ b/base/src/main/java/bjc/utils/funcdata/bst/DirectedWalkFunction.java
@@ -6,7 +6,7 @@ package bjc.utils.funcdata.bst;
* @author ben
*
* @param <T>
- * The type of element stored in the walked tree
+ * The type of element stored in the walked tree
*/
@FunctionalInterface
public interface DirectedWalkFunction<T> {
@@ -14,12 +14,9 @@ public interface DirectedWalkFunction<T> {
* Represents the results used to direct a walk in a binary tree.
*
* @author ben
- *
*/
public enum DirectedWalkResult {
- /**
- * Specifies that the function has failed.
- */
+ /** Specifies that the function has failed. */
FAILURE,
/**
* Specifies that the function wants to move left in the tree
@@ -31,10 +28,7 @@ public interface DirectedWalkFunction<T> {
* next.
*/
RIGHT,
- /**
- * Specifies that the function has succesfully completed
- *
- */
+ /** Specifies that the function has succesfully completed */
SUCCESS
}
@@ -42,8 +36,10 @@ public interface DirectedWalkFunction<T> {
* Perform a directed walk on a node of a tree.
*
* @param element
- * The data stored in the node currently being visited
- * @return The way the function wants the walk to go next.
+ * The data stored in the node currently being visited.
+ *
+ * @return
+ * The way the function wants the walk to go next.
*/
public DirectedWalkResult walk(T element);
}