Java docs for v1_6 models, done is parts.

Author: TVolden

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/model/AuthorizationStatus.java

@@ -1,6 +1,6 @@
 package eu.chargetime.ocpp.model;
 
-/**
+/*
  * ChargeTime.eu - Java-OCA-OCPP
  * <p>
  * MIT License
@@ -25,6 +25,12 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
+/**
+ * Accepted values {@link IdTagInfo} for {@link AuthorizeConfirmation}.
+ *
+ * @see IdTagInfo
+ */
 public enum AuthorizationStatus {
     Accepted, Blocked, Expired, Invalid, ConcurrentTx
 }

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/model/AuthorizeConfirmation.java

@@ -1,6 +1,6 @@
 package eu.chargetime.ocpp.model;
 
-/**
+/*
  ChargeTime.eu - Java-OCA-OCPP
  Copyright (C) 2015-2016 Thomas Volden <[email protected]>
 
@@ -26,15 +26,29 @@ 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.
  */
+
+/**
+ * Sent by the Centarl System to the Charge Point in response to a {@link AuthorizeRequest}.
+ */
 public class AuthorizeConfirmation implements Confirmation
 {
     private IdTagInfo idTagInfo;
 
+    /**
+     * This contains information about authorization status, expiry and parent id.
+     *
+     * @return an instance of {@link IdTagInfo}.
+     */
     public IdTagInfo getIdTagInfo()
     {
         return idTagInfo;
     }
 
+    /**
+     * Required. This contains information about authorization status, expiry and parent id.
+     *
+     * @param idTagInfo an instance of {@link IdTagInfo}.
+     */
     public void setIdTagInfo(IdTagInfo idTagInfo) {
         this.idTagInfo = idTagInfo;
     }

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/model/AuthorizeRequest.java

@@ -3,7 +3,7 @@
 import eu.chargetime.ocpp.PropertyConstraintException;
 import eu.chargetime.ocpp.utilities.ModelUtil;
 
-/**
+/*
  ChargeTime.eu - Java-OCA-OCPP
  Copyright (C) 2015-2016 Thomas Volden <[email protected]>
 
@@ -29,22 +29,43 @@ 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.
  */
+
+/**
+ * Sent by the Charge Point to the Central System.
+ */
 public class AuthorizeRequest implements Request
 {
     private String idTag;
 
     public AuthorizeRequest() {}
 
+    /**
+     * Handle required fields.
+     *
+     * @param idToken authorize id.
+     * @throws PropertyConstraintException field isn't filled out correct.
+     */
     public AuthorizeRequest(String idToken) throws PropertyConstraintException
     {
          setIdTag(idToken);
     }
 
+    /**
+     * This contains the identifier that needs to be authorized.
+     *
+     * @return String, max 20 characters. Case insensitive.
+     */
     public String getIdTag()
     {
         return idTag;
     }
 
+    /**
+     * Required. This contains the identifier that needs to be authorized.
+     *
+     * @param idTag                         String, max 20 characters. Case insensitive.
+     * @throws PropertyConstraintException  field isn't filled out correct.
+     */
     public void setIdTag(String idTag) throws PropertyConstraintException {
         if (!ModelUtil.validate(idTag, 20))
             throw new PropertyConstraintException("idTag", idTag, "Exceeded limit");

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/model/AvailabilityStatus.java

@@ -1,22 +1,22 @@
 package eu.chargetime.ocpp.model;
 
-/**
+/*
  * ChargeTime.eu - Java-OCA-OCPP
- * <p>
+ *
  * MIT License
- * <p>
+ *
  * Copyright (C) 2016 Thomas Volden <[email protected]>
- * <p>
+ *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
- * <p>
+ *
  * The above copyright notice and this permission notice shall be included in all
  * copies or substantial portions of the Software.
- * <p>
+ *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -25,6 +25,12 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
+/**
+ * Accepted values for {@link ChangeAvailabilityConfirmation}.
+ *
+ * @see ChangeAvailabilityConfirmation
+ */
 public enum AvailabilityStatus {
     Accepted, Rejected, Scheduled
 }

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/model/AvailabilityType.java

@@ -1,22 +1,22 @@
 package eu.chargetime.ocpp.model;
 
-/**
+/*
  * ChargeTime.eu - Java-OCA-OCPP
- * <p>
+ *
  * MIT License
- * <p>
+ *
  * Copyright (C) 2016 Thomas Volden <[email protected]>
- * <p>
+ *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
- * <p>
+ *
  * The above copyright notice and this permission notice shall be included in all
  * copies or substantial portions of the Software.
- * <p>
+ *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -25,6 +25,12 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
+/**
+ * Accepted values for {@link ChangeAvailabilityRequest}.
+ *
+ * @see ChangeAvailabilityRequest
+ */
 public enum AvailabilityType {
     Inoperative, Operative
 }

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/model/BootNotificationConfirmation.java

@@ -6,7 +6,7 @@
 import java.util.Calendar;
 import java.util.TimeZone;
 
-/**
+/*
  ChargeTime.eu - Java-OCA-OCPP
  Copyright (C) 2015-2016 Thomas Volden <[email protected]>
 
@@ -32,51 +32,103 @@ 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.
  */
+
+/**
+ * Sent by the Central System to the Charge Point in response to a {@link BootNotificationRequest}.
+ *
+ * @see BootNotificationRequest
+ */
 public class BootNotificationConfirmation implements Confirmation
 {
     private Calendar currentTime;
     private int interval;
     private RegistrationStatus status;
 
+    /**
+     * Formattet Central System's current time.
+     * Pattern: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
+     *
+     * @return Formattet time.
+     */
     public String getCurrentTime()
     {
         SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'");
         formatter.setTimeZone(TimeZone.getTimeZone("GMT+00:00"));
         return formatter.format(currentTime.getTime());
     }
 
+    /**
+     * Central System's current time.
+     *
+     * @return an instance of Calendar.
+     */
     public Calendar objCurrentTime() {
         return currentTime;
     }
 
+    /**
+     * Required. This contains the Central System’s current time.
+     *
+     * @param currentTime Central System’s current time.
+     */
     public void setCurrentTime(Calendar currentTime)
     {
         this.currentTime = currentTime;
     }
 
+    /**
+     * When RegistrationStatus is Accepted, this contains the heartbeat interval in seconds.
+     * If the Central System returns something other than Accepted, the value of the interval field
+     * indicates the minimum wait time before sending a next BootNotification request.
+     *
+     * @return Heartbeat/delay interval in seconds.
+     */
     public int getInterval()
     {
         return interval;
     }
 
+    /**
+     * Required. When RegistrationStatus is Accepted, this contains the heartbeat interval in seconds.
+     * If the Central System returns something other than Accepted, the value of the interval field
+     * indicates the minimum wait time before sending a next BootNotification request.
+     *
+     * @param interval heartbeat/delay interval in seconds. Min value 0.
+     * @throws PropertyConstraintException field isn't filled out correct.
+     */
     public void setInterval(int interval) throws PropertyConstraintException {
         if (interval <= 0)
             throw new PropertyConstraintException("interval", interval, "Must be a positive value");
 
         this.interval = interval;
     }
 
+    /**
+     * This contains whether the Charge Point has been registered within the System Central.
+     *
+     * @return Charge Points registration status as {@link RegistrationStatus}.
+     */
     public RegistrationStatus objStatus()
     {
         return status;
     }
 
+    /**
+     * This contains whether the Charge Point has been registered within the System Central.
+     *
+     * @return Charge Points registration status as String.
+     */
     public String getStatus()
     {
         return status.toString();
     }
 
-    public void setStatus(RegistrationStatus status) throws PropertyConstraintException {
+    /**
+     * Required. This contains whether the Charge Point has been registered within the System Central.
+     *
+     * @param status                        Charge Points registration status.
+     */
+    public void setStatus(RegistrationStatus status) {
         this.status = status;
     }