Add simple toggle values

1 files changed, 35 insertions, 0 deletions

diff --git a/BJC-Utils2/src/main/java/bjc/utils/data/Toggle.java b/BJC-Utils2/src/main/java/bjc/utils/data/Toggle.java
new file mode 100644
index 0000000..8ebc4d8
--- /dev/null
+++ b/BJC-Utils2/src/main/java/bjc/utils/data/Toggle.java
@@ -0,0 +1,35 @@
+package bjc.utils.data;
+
+/**
+ * A stateful holder that swaps between two values of the same type.
+ * 
+ * @author EVE
+ *
+ * @param <E>
+ *                The value stored in the toggle.
+ */
+public interface Toggle<E> {
+	/**
+	 * Retrieve the currently-aligned value of this toggle, and swap the
+	 * alignment.
+	 * 
+	 * @return The previously-aligned value.
+	 */
+	E get();
+
+	/**
+	 * Retrieve the currently-aligned value without altering the alignment.
+	 * 
+	 * @return The currently-aligned value.
+	 */
+	E peek();
+
+	/**
+	 * Change the alignment of the toggle.
+	 * 
+	 * @param isLeft
+	 *                Whether the toggle should be left-aligned or not.
+	 */
+	void set(boolean isLeft);
+
+}
\ No newline at end of file