Started java docs for v1_6

Author: TVolden

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/JSONClient.java

@@ -2,23 +2,23 @@
 
 import eu.chargetime.ocpp.feature.profile.CoreProfile;
 
-/**
+/*
  * 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
@@ -27,8 +27,17 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
+/**
+ * OCA OCPP version 1.6 JSON Web Socket implementation of the client.
+ */
 public class JSONClient extends Client {
 
+    /**
+     * The core feature profile is required as a minimum.
+     *
+     * @param coreProfile implementation of the core feature profile.
+     */
     public JSONClient(CoreProfile coreProfile) {
         super(new Session(new JSONCommunicator(new WebSocketTransmitter()), new Queue()));
         addFeatureProfile(coreProfile);

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/JSONCommunicator.java

@@ -12,7 +12,7 @@
 import java.lang.reflect.Type;
 import java.util.Calendar;
 
-/**
+/*
  ChargeTime.eu - Java-OCA-OCPP
  Copyright (C) 2015-2016 Thomas Volden <[email protected]>
 
@@ -38,6 +38,10 @@ 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.
  */
+
+/**
+ * Communicator for JSON messages
+ */
 public class JSONCommunicator extends Communicator {
 
     private static final int INDEX_MESSAGEID = 0;
@@ -47,10 +51,16 @@ public class JSONCommunicator extends Communicator {
     private static final int TYPENUMBER_CALLRESULT = 3;
     private static final int INDEX_CALLRESULT_PAYLOAD = 2;
     private static final int INDEX_UNIQUEID = 1;
+
     private static final String CALL_FORMAT = "[2,\"%s\",\"%s\",%s]";
     private static final String CALLRESULT_FORMAT = "[3,\"%s\",%s]";
     private static final String CALLERROR_FORMAT = "[4,\"%s\",\"%s\",\"%s\",%s]";
 
+    /**
+     * Handle required injections.
+     *
+     * @param transmitter instance of the {@link Transmitter}.
+     */
     public JSONCommunicator(Transmitter transmitter) {
         super(transmitter);
     }

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/WebSocketTransmitter.java

@@ -5,6 +5,36 @@
 
 import java.net.URI;
 
+/*
+ ChargeTime.eu - Java-OCA-OCPP
+ Copyright (C) 2015-2016 Thomas Volden <[email protected]>
+
+ MIT License
+
+ Copyright (c) 2016 Thomas Volden
+
+ 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:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ 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
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE.
+ */
+
+/**
+ * Web Socket implementation of the Transmitter.
+ */
 public class WebSocketTransmitter implements Transmitter
 {
     private WebSocketClient client;

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/feature/profile/ClientCoreEventHandler.java

@@ -2,7 +2,7 @@
 
 import eu.chargetime.ocpp.model.*;
 
-/**
+/*
  ChargeTime.eu - Java-OCA-OCPP
  Copyright (C) 2015-2016 Thomas Volden <[email protected]>
 
@@ -28,15 +28,80 @@ 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.
  */
+
+/**
+ * Call back handler for client events of the core feature profile.
+ */
 public interface ClientCoreEventHandler {
+    /**
+     * Handle a {@link ChangeAvailabilityRequest} and return a {@link ChangeAvailabilityConfirmation}.
+     *
+     * @param request incoming {@link ChangeAvailabilityRequest} to handle.
+     * @return outgoing {@link ChangeAvailabilityConfirmation} to reply with.
+     */
     ChangeAvailabilityConfirmation handleChangeAvailabilityRequest(ChangeAvailabilityRequest request);
+
+    /**
+     * Handle a {@link GetConfigurationRequest} and return a {@link GetConfigurationConfirmation}.
+     *
+     * @param request   incoming {@link GetConfigurationRequest} to handle.
+     * @return outgoing {@link GetConfigurationConfirmation} to reply with.
+     */
     GetConfigurationConfirmation handleGetConfigurationRequest(GetConfigurationRequest request);
+
+    /**
+     * Handle a {@link ChangeConfigurationRequest} and return a {@link ChangeConfigurationConfirmation}.
+     *
+     * @param request   incoming {@link ChangeConfigurationRequest} to handle.
+     * @return outgoing {@link ChangeConfigurationConfirmation} to reply with.
+     */
     ChangeConfigurationConfirmation handleChangeConfigurationRequest(ChangeConfigurationRequest request);
+
+    /**
+     * Handle a {@link ClearCacheRequest} and return a {@link ClearCacheConfirmation}.
+     *
+     * @param request   incoming {@link ClearCacheRequest} to handle.
+     * @return outgoing {@link ClearCacheConfirmation} to reply with.
+     */
     ClearCacheConfirmation handleClearCacheRequest(ClearCacheRequest request);
+
+    /**
+     * Handle a {@link DataTransferRequest} and return a {@link DataTransferConfirmation}.
+     *
+     * @param request   incoming {@link DataTransferRequest} to handle.
+     * @return outgoing {@link DataTransferConfirmation} to reply with.
+     */
     DataTransferConfirmation handleDataTransferRequest(DataTransferRequest request);
+
+    /**
+     * Handle a {@link RemoteStartTransactionRequest} and return a {@link RemoteStartTransactionConfirmation}.
+     *
+     * @param request   incoming {@link RemoteStartTransactionRequest} to handle.
+     * @return outgoing {@link RemoteStartTransactionConfirmation} to reply with.
+     */
     RemoteStartTransactionConfirmation handleRemoteStartTransactionRequest(RemoteStartTransactionRequest request);
+
+    /**
+     * Handle a {@link RemoteStopTransactionRequest} and return a {@link RemoteStopTransactionConfirmation}.
+     *
+     * @param request   incoming {@link RemoteStopTransactionRequest} to handle.
+     * @return outgoing {@link RemoteStopTransactionConfirmation} to reply with.
+     */
     RemoteStopTransactionConfirmation handleRemoteStopTransactionRequest(RemoteStopTransactionRequest request);
+
+    /**
+     * Handle a {@link ResetRequest} and return a {@link ResetConfirmation}.
+     *
+     * @param request   incoming {@link ResetRequest} to handle.
+     * @return outgoing {@link ResetConfirmation} to reply with.
+     */
     ResetConfirmation handleResetRequest(ResetRequest request);
 
+    /**
+     * Handle a {@link UnlockConnectorRequest} and return a {@link UnlockConnectorConfirmation}.
+     *
+     * @param request   incoming {@link UnlockConnectorRequest} to handle.
+     * @return outgoing {@link UnlockConnectorConfirmation} to reply with.
+     */
     UnlockConnectorConfirmation handleUnlockConnectorRequest(UnlockConnectorRequest request);
 }

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/feature/profile/CoreProfile.java

@@ -7,7 +7,7 @@
 import java.util.ArrayList;
 import java.util.Calendar;
 
-/**
+/*
  ChargeTime.eu - Java-OCA-OCPP
  Copyright (C) 2015-2016 Thomas Volden <[email protected]>
 
@@ -33,11 +33,22 @@ 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.
  */
+
+/**
+ * The core feature profile contains the features from OCPP v. 1.5
+ * <p>
+ * Contains methods to create outgoing client requests.
+ */
 public class CoreProfile implements Profile
 {
     ClientCoreEventHandler eventHandler;
     ArrayList<Feature> features;
 
+    /**
+     * Set up handler for client core feature requests.
+
+     * @param handler   call back methods for client events
+     */
     public CoreProfile(ClientCoreEventHandler handler) {
         features = new ArrayList<>();
         eventHandler = handler;
@@ -60,42 +71,119 @@ public CoreProfile(ClientCoreEventHandler handler) {
         features.add(new UnlockConnectorFeature(this));
     }
 
+    /**
+     * Create a client {@link AuthorizeRequest} with required values.
+     *
+     * @param idToken   required identification token.
+     * @return an instance of {@link AuthorizeRequest}.
+     * @throws PropertyConstraintException  cast if requires fields isn't filled out correctly.
+     * @see AuthorizeRequest
+     * @see AuthorizeFeature
+     */
     public AuthorizeRequest createAuthorizeRequest(String idToken) throws PropertyConstraintException {
         return new AuthorizeRequest(idToken);
     }
 
+    /**
+     * Create a client {@link BootNotificationRequest} with required values.
+     *
+     * @param vendor    required. Vendor name.
+     * @param model     required. Charge box model.
+     * @return an instance of {@link BootNotificationRequest}
+     * @see BootNotificationRequest
+     * @see BootNotificationFeature
+     */
     public BootNotificationRequest createBootNotificationRequest(String vendor, String model) {
         return new BootNotificationRequest(vendor, model);
     }
 
+    /**
+     * Create a client {@link DataTransferRequest} with required values.
+     *
+     * @param vendorId  required. Vendor identification.
+     * @return an instance of {@link DataTransferRequest}.
+     * @see DataTransferRequest
+     * @see DataTransferFeature
+     */
     public DataTransferRequest createDataTransferRequest(String vendorId) {
         return new DataTransferRequest(vendorId);
     }
 
+    /**
+     * Create a client {@link HeartbeatRequest}.
+     *
+     * @return an instance of {@link HeartbeatRequest}
+     * @see HeartbeatRequest
+     * @see HeartbeatFeature
+     */
     public HeartbeatRequest createHeartbeatRequest() {
         return new HeartbeatRequest();
     }
 
+    /**
+     * Create a client {@link MeterValuesRequest} with one {@link SampledValue} and one {@link MeterValue}
+     *
+     * @param connectorId   required. Identification of connector.
+     * @param timestamp     required. Time of sample.
+     * @param value         required. Value of sample.
+     * @return an instance of {@link MeterValuesRequest}.
+     * @throws PropertyConstraintException  thrown if a required field isn't filled out correctly.
+     * @see MeterValuesRequest
+     * @see MeterValuesFeature
+     */
     public MeterValuesRequest createMeterValuesRequest(Integer connectorId, Calendar timestamp, String value) throws PropertyConstraintException {
         SampledValue sampledValue = new SampledValue();
         sampledValue.setValue(value);
         return createMeterValuesRequest(connectorId, timestamp, sampledValue);
     }
 
+    /**
+     * Create a client {@link MeterValuesRequest} with some {@link SampledValue}s and one {@link MeterValue}.
+     *
+     * @param connectorId   required. Identification of connector.
+     * @param timestamp     required. Time of sample.
+     * @param sampledValues required. Params list of {@link SampledValue}s
+     * @return an instance of {@link MeterValuesRequest}
+     * @throws PropertyConstraintException  thrown if a required field isn't filled out correctly.
+     * @see MeterValuesRequest
+     * @see MeterValuesFeature
+     */
     public MeterValuesRequest createMeterValuesRequest(Integer connectorId, Calendar timestamp, SampledValue... sampledValues) throws PropertyConstraintException {
         MeterValue meterValue = new MeterValue();
         meterValue.setTimestamp(timestamp);
         meterValue.setSampledValue(sampledValues);
         return createMeterValuesRequest(connectorId, meterValue);
     }
 
+    /**
+     * Create a client {@link MeterValuesRequest} with some {@link MeterValue}s.
+     *
+     * @param connectorId   required. Identification of connector.
+     * @param meterValues   required. Params list of {@link MeterValue}s
+     * @return an instance of {@link MeterValuesRequest}
+     * @throws PropertyConstraintException  thrown if a required field isn't filled out correctly.
+     * @see MeterValuesRequest
+     * @see MeterValuesFeature
+     */
     public MeterValuesRequest createMeterValuesRequest(Integer connectorId, MeterValue... meterValues) throws PropertyConstraintException {
         MeterValuesRequest request = new MeterValuesRequest();
         request.setConnectorId(connectorId);
         request.setMeterValue(meterValues);
         return request;
     }
 
+    /**
+     * Create a client {@link StartTransactionRequest} with required values.
+     *
+     * @param connectorId   required. Identification of the connector.
+     * @param idTag         required. Authorization identification tag.
+     * @param meterStart    required. The initial value of the meter.
+     * @param timestamp     required. Time of start.
+     * @return an instance of {@link StartTransactionRequest}.
+     * @throws PropertyConstraintException thrown if a required field isn't filled out correctly.
+     * @see StartTransactionRequest
+     * @see StartTransactionFeature
+     */
     public StartTransactionRequest createStartTransactionRequest(Integer connectorId, String idTag, Integer meterStart, Calendar timestamp) throws PropertyConstraintException {
         StartTransactionRequest request = new StartTransactionRequest();
         request.setConnectorId(connectorId);
@@ -107,6 +195,17 @@ public StartTransactionRequest createStartTransactionRequest(Integer connectorId
         return request;
     }
 
+    /**
+     * Create a client {@link StatusNotificationRequest} with required values.
+     *
+     * @param connectorId   required. Identification of the connector.
+     * @param errorCode     required. {@link ChargePointErrorCode} of the connector.
+     * @param status        required. {@link ChargePointStatus} of the connector.
+     * @return an instance of {@link StatusNotificationRequest}.
+     * @throws PropertyConstraintException thrown if a required field isn't filled out correctly.
+     * @see StatusNotificationRequest
+     * @see StatusNotificationFeature
+     */
     public StatusNotificationRequest createStatusNotificationRequest(Integer connectorId, ChargePointErrorCode errorCode, ChargePointStatus status) throws PropertyConstraintException {
         StatusNotificationRequest request = new StatusNotificationRequest();
         request.setConnectorId(connectorId);
@@ -115,6 +214,14 @@ public StatusNotificationRequest createStatusNotificationRequest(Integer connect
         return request;
     }
 
+    /**
+     * Create a client {@link StopTransactionRequest} with required values.
+     *
+     * @param meterStop        required. The final value of the meter.
+     * @param timestamp        required. Time of stop.
+     * @param transactionId    required. The identification of the transaction.
+     * @return an instance of {@link StopTransactionRequest}.
+     */
     public StopTransactionRequest createStopTransactionRequest(int meterStop, Calendar timestamp, int transactionId) {
         StopTransactionRequest request = new StopTransactionRequest();
         request.setMeterStop(meterStop);