summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/data/Toggle.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/data/Toggle.java
parentc82e3b3b2de0633317ec8fc85925e91422820597 (diff)
Cleanup work
Diffstat (limited to 'base/src/main/java/bjc/utils/data/Toggle.java')
-rw-r--r--base/src/main/java/bjc/utils/data/Toggle.java15
1 files changed, 8 insertions, 7 deletions
diff --git a/base/src/main/java/bjc/utils/data/Toggle.java b/base/src/main/java/bjc/utils/data/Toggle.java
index 1e10dae..a1467e4 100644
--- a/base/src/main/java/bjc/utils/data/Toggle.java
+++ b/base/src/main/java/bjc/utils/data/Toggle.java
@@ -6,21 +6,23 @@ package bjc.utils.data;
* @author EVE
*
* @param <E>
- * The value stored in the toggle.
+ * The value stored in the toggle.
*/
public interface Toggle<E> {
/**
* Retrieve the currently-aligned value of this toggle, and swap the
- * alignment.
+ * value to the new one.
*
- * @return The previously-aligned value.
+ * @return
+ * The previously-aligned value.
*/
E get();
/**
* Retrieve the currently-aligned value without altering the alignment.
*
- * @return The currently-aligned value.
+ * @return
+ * The currently-aligned value.
*/
E peek();
@@ -28,8 +30,7 @@ public interface Toggle<E> {
* Change the alignment of the toggle.
*
* @param isLeft
- * Whether the toggle should be left-aligned or not.
+ * Whether the toggle should be left-aligned or not.
*/
void set(boolean isLeft);
-
-} \ No newline at end of file
+}