1 files changed, 34 insertions, 0 deletions
diff --git a/src/main/java/bjc/data/Toggle.java b/src/main/java/bjc/data/Toggle.java
new file mode 100644
index 0000000..14c77d3
--- /dev/null
+++ b/src/main/java/bjc/data/Toggle.java
@@ -0,0 +1,34 @@
+package bjc.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
+	 * value to the new one.
+	 *
+	 * @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);
+}