Created Cycleable interface

Author: ZeroMemes

src/main/java/clientapi/util/interfaces/Cycleable.java

@@ -0,0 +1,48 @@
+package clientapi.util.interfaces;
+
+/**
+ * @author Brady
+ * @since 4/12/2018 6:53 PM
+ */
+public interface Cycleable<T> {
+
+    /**
+     * @return The current selected element
+     */
+    T current();
+
+    /**
+     * Sets the current element to the one succeeding it.
+     *
+     * @return The next element
+     */
+    T next();
+
+    /**
+     * Sets the current element to the one preceding it.
+     *
+     * @return The next element
+     */
+    T last();
+
+    /**
+     * Peeks at the element succeeding the current one
+     * without setting the current one to it.
+     *
+     * @return The next element
+     */
+    T peekNext();
+
+    /**
+     * Peeks at the element preceding the current one
+     * without setting the current one to it.
+     *
+     * @return The next element
+     */
+    T peekLast();
+
+    /**
+     * @return All of the elements in this {@code Cycleable};
+     */
+    T[] getElements();
+}

src/main/java/clientapi/value/type/EnumType.java

@@ -16,6 +16,7 @@
 
 package clientapi.value.type;
 
+import clientapi.util.interfaces.Cycleable;
 import clientapi.value.Value;
 import clientapi.value.annotation.EnumValue;
 import org.apache.commons.lang3.ArrayUtils;
@@ -30,7 +31,7 @@
  * @author Brady
  * @since 12/1/2017 7:12 PM
  */
-public final class EnumType<T extends Enum<?>> extends Value<T> {
+public final class EnumType<T extends Enum<?>> extends Value<T> implements Cycleable<T> {
 
     private final T[] values;
 
@@ -39,27 +40,43 @@ public EnumType(String name, String parent, String id, String description, Objec
         this.values = enumClass.getEnumConstants();
     }
 
-    /**
-     * Sets value to the next one in the set
-     */
-    public final void next() {
+    @Override
+    public final T current() {
+        return this.getValue();
+    }
+
+    @Override
+    public final T next() {
+        T value = peekNext();
+        this.setValue(value);
+        return value;
+    }
+
+    @Override
+    public final T last() {
+        T value = peekLast();
+        this.setValue(value);
+        return value;
+    }
+
+    @Override
+    public final T peekNext() {
         int index = ArrayUtils.indexOf(values, getValue());
         if (++index >= values.length)
             index = 0;
-        this.setValue(values[index]);
+        return values[index];
     }
 
-    /**
-     * Sets value to the last one in the set
-     */
-    public final void last() {
+    @Override
+    public final T peekLast() {
         int index = ArrayUtils.indexOf(values, getValue());
         if (--index < 0)
             index = values.length - 1;
-        this.setValue(values[index]);
+        return values[index];
     }
 
-    public final T[] getMultiValues() {
+    @Override
+    public final T[] getElements() {
         return this.values;
     }
 }

src/main/java/clientapi/value/type/MultiType.java

@@ -17,6 +17,7 @@
 package clientapi.value.type;
 
 import clientapi.util.ClientAPIUtils;
+import clientapi.util.interfaces.Cycleable;
 import clientapi.value.Value;
 import org.apache.commons.lang3.ArrayUtils;
 
@@ -28,7 +29,7 @@
  * @author Brady
  * @since 2/24/2017 12:00 PM
  */
-public final class MultiType extends Value<String> {
+public final class MultiType extends Value<String> implements Cycleable<String> {
 
     /**
      * Different values
@@ -46,30 +47,43 @@ public final void setValue(String value) {
         super.setValue(ClientAPIUtils.objectFrom(value, values));
     }
 
-    /**
-     * Sets value to the next one in the set
-     */
-    public final void next() {
+    @Override
+    public final String current() {
+        return this.getValue();
+    }
+
+    @Override
+    public final String next() {
+        String value = peekNext();
+        this.setValue(value);
+        return value;
+    }
+
+    @Override
+    public final String last() {
+        String value = peekLast();
+        this.setValue(value);
+        return value;
+    }
+
+    @Override
+    public final String peekNext() {
         int index = ArrayUtils.indexOf(values, getValue());
         if (++index >= values.length)
             index = 0;
-        this.setValue(values[index]);
+        return values[index];
     }
 
-    /**
-     * Sets value to the last one in the set
-     */
-    public final void last() {
+    @Override
+    public final String peekLast() {
         int index = ArrayUtils.indexOf(values, getValue());
         if (--index < 0)
             index = values.length - 1;
-        this.setValue(values[index]);
+        return values[index];
     }
 
-    /**
-     * @return All possible values for this MultiType
-     */
-    public final String[] getMultiValues() {
+    @Override
+    public final String[] getElements() {
         return this.values;
     }
 }

src/main/java/clientapi/value/type/resolve/impl/EnumTypeResolver.java

@@ -39,7 +39,7 @@ public final EnumType resolve(Object parent, Field field) {
 
         EnumType type = new EnumType(label.name(), label.parent(), label.id(), label.description(), parent, field, enumType);
         if (type.getValue() == null)
-            type.setValue(type.getMultiValues()[0]);
+            type.setValue(type.getElements()[0]);
 
         return type;
     }

src/main/java/clientapi/value/type/resolve/impl/MultiTypeResolver.java

@@ -38,7 +38,7 @@ public final MultiType resolve(Object parent, Field field) {
 
         MultiType type = new MultiType(label.name(), label.parent(), label.id(), label.description(), parent, field, multi.value());
         if (type.getValue() == null)
-            type.setValue(type.getMultiValues()[0]);
+            type.setValue(type.getElements()[0]);
 
         return type;
     }