summaryrefslogtreecommitdiff
path: root/BJC-Utils2/src/main/java/bjc/utils/funcdata/bst/DirectedWalkFunction.java
blob: e68bef6e39c9abc93598d151cd5006c4f3becf3f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
package bjc.utils.funcdata.bst;

/**
 * Represents a function for doing a directed walk of a binary tree.
 * 
 * @author ben
 *
 * @param <T>
 *                The type of element stored in the walked tree
 */
@FunctionalInterface
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.
		 */
		FAILURE,
		/**
		 * Specifies that the function wants to move left in the tree
		 * next.
		 */
		LEFT,
		/**
		 * Specifies that the function wants to move right in the tree
		 * next.
		 */
		RIGHT,
		/**
		 * Specifies that the function has succesfully completed
		 * 
		 */
		SUCCESS
	}

	/**
	 * 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.
	 */
	public DirectedWalkResult walk(T element);
}