Java docs for v1_6 models, done.

Author: TVolden

ocpp-common/src/main/java/eu/chargetime/ocpp/Client.java

@@ -102,6 +102,21 @@ public Confirmation handleRequest(Request request) {
                 Feature feature = findFeatureByRequest(request);
                 return feature.handleRequest(request);
             }
+
+            @Override
+            public void handleError(String uniqueId) {
+
+            }
+
+            @Override
+            public void handleConnectionClosed() {
+
+            }
+
+            @Override
+            public void handleConnectionOpened() {
+
+            }
         });
     }
 

ocpp-common/src/main/java/eu/chargetime/ocpp/SessionEvents.java

@@ -40,7 +40,7 @@ public interface SessionEvents {
      * If null is returned, a "NotImplemented" error will be send.
      *
      * @param action action name of the {@link Feature}
-     * @return {@Link Feature} found.
+     * @return {@link Feature} found.
      */
     Feature findFeatureByAction(String action);
 

ocpp-common/src/main/java/eu/chargetime/ocpp/model/Message.java

@@ -1,6 +1,6 @@
 package eu.chargetime.ocpp.model;
 
-/**
+/*
  ChargeTime.eu - Java-OCA-OCPP
  Copyright (C) 2015-2016 Thomas Volden <[email protected]>
 
@@ -26,22 +26,46 @@ of this software and associated documentation files (the "Software"), to deal
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
  */
+
+/**
+ * Wrapper class for a message
+ */
 public class Message {
     private String id;
     private String payload;
 
+    /**
+     * Get unique id for message.
+     *
+     * @return message id.
+     */
     public String getId() {
         return id;
     }
 
+    /**
+     * Set unique id for message.
+     *
+     * @param id String, message id.
+     */
     public void setId(String id) {
         this.id = id;
     }
 
+    /**
+     * Get attached payload.
+     *
+     * @return payload.
+     */
     public String getPayload() {
         return payload;
     }
 
+    /**
+     * Attach payload to message.
+     *
+     * @param payload String, payload.
+     */
     public void setPayload(String payload) {
         this.payload = payload;
     }

ocpp-common/src/main/java/eu/chargetime/ocpp/utilities/ModelUtil.java

@@ -1,6 +1,6 @@
 package eu.chargetime.ocpp.utilities;
 
-/**
+/*
  ChargeTime.eu - Java OCA OCPP
  Copyright (C) 2015-2016 Thomas Volden <[email protected]>
 
@@ -26,8 +26,19 @@ of this software and associated documentation files (the "Software"), to deal
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
  */
+
+/**
+ * Utilities for model classes. Used to validate values.
+ */
 public abstract class ModelUtil {
 
+    /**
+     * Check if a value is in a list of values.
+     *
+     * @param needle   value we want to search for.
+     * @param hayStack list of value that we search in.
+     * @return true if value was found in list.
+     */
     public static boolean isAmong(Object needle, Object... hayStack) {
         boolean found = false;
         if (hayStack != null) {
@@ -40,6 +51,12 @@ public static boolean isAmong(Object needle, Object... hayStack) {
         return found;
     }
 
+    /**
+     * Compares two values.
+     * @param object1   Right value to compare.
+     * @param object2   Left value to compare.
+     * @return Both values are null or equal.
+     */
     private static boolean isNullOrEqual(Object object1, Object object2) {
         boolean nullOrEqual = false;
         if (object1 == null && object2 == null) {
@@ -50,6 +67,13 @@ private static boolean isNullOrEqual(Object object1, Object object2) {
         return nullOrEqual;
     }
 
+    /**
+     * Check if a string exceeds a given length.
+     *
+     * @param input         The string to check.
+     * @param maxLength     The largest length accepted.
+     * @return The string length does not exceed max length.
+     */
     public static boolean validate(String input, int maxLength) {
         return input != null && input.length() <= maxLength;
     }

ocpp-common/src/main/java/eu/chargetime/ocpp/utilities/TestUtilities.java

@@ -1,6 +1,6 @@
 package eu.chargetime.ocpp.utilities;
 
-/**
+/*
  * ChargeTime.eu - Java-OCA-OCPP
  *
  * MIT License
@@ -25,8 +25,18 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
+/**
+ * Utilities for tests. Used to quickly create usefull objects.
+ */
 public class TestUtilities {
 
+    /**
+     * Create a string of a given length.
+     *
+     * @param length the desired length.
+     * @return A string of the desired length.
+     */
     protected String aString(int length) {
         String lorem = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus bibendum eros vitae sapien metusa.";
 
@@ -41,10 +51,24 @@ protected String aString(int length) {
         return lorem.substring(0, length);
     }
 
+    /**
+     * Create an array of elements.
+     *
+     * @param objects   Params of elements to add to the list.
+     * @param <T>       The type of the elements.
+     * @return An array of the given elements.
+     */
     protected <T> T[] aList(T... objects) {
         return objects;
     }
 
+    /**
+     * Create a String from an Array.
+     *
+     * @param delimiter Used to split the values.
+     * @param array     The array to print.
+     * @return Formatted string, with array values.
+     */
     protected String join(String delimiter, Object[] array) {
         StringBuilder output = new StringBuilder();
 

ocpp-common/src/test/java/eu/chargetime/ocpp/test/ClientTest.java

@@ -20,7 +20,7 @@
 import static org.junit.Assert.assertThat;
 import static org.mockito.Mockito.*;
 
-/**
+/*
  ChargeTime.eu - Java-OCA-OCPP
  Copyright (C) 2015-2016 Thomas Volden <[email protected]>
 

ocpp-common/src/test/java/eu/chargetime/ocpp/test/QueueTest.java

@@ -9,7 +9,7 @@
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.mockito.Mockito.mock;
 
-/**
+/*
  ChargeTime.eu - Java-OCA-OCPP
  Copyright (C) 2015-2016 Thomas Volden <[email protected]>
 

ocpp-common/src/test/java/eu/chargetime/ocpp/test/SessionTest.java

@@ -13,7 +13,7 @@
 import static org.junit.Assert.assertThat;
 import static org.mockito.Mockito.*;
 
-/**
+/*
  ChargeTime.eu - Java-OCA-OCPP
  Copyright (C) 2015-2016 Thomas Volden <[email protected]>
 

ocpp-common/src/test/java/eu/chargetime/ocpp/utilities/test/ModelUtilTest.java

@@ -6,7 +6,7 @@
 import static org.hamcrest.CoreMatchers.is;
 import static org.junit.Assert.assertThat;
 
-/**
+/*
  ChargeTime.eu - Java OCA OCPP
  Copyright (C) 2015-2016 Thomas Volden <[email protected]>
 

ocpp-v1_6-example/src/main/core_features/JSONClientSample.java

@@ -6,7 +6,7 @@
 import eu.chargetime.ocpp.feature.profile.CoreProfile;
 import eu.chargetime.ocpp.model.*;
 
-/**
+/*
  * ChargeTime.eu - Java-OCA-OCPP
  * Copyright (C) 2015-2016 Thomas Volden <[email protected]>
  *