Fix javadoc issue 86/91086/2
authorGilles Thouenon <gilles.thouenon@orange.com>
Fri, 10 Jul 2020 10:23:40 +0000 (12:23 +0200)
committerGilles Thouenon <gilles.thouenon@orange.com>
Fri, 10 Jul 2020 16:33:45 +0000 (16:33 +0000)
Signed-off-by: Gilles Thouenon <gilles.thouenon@orange.com>
Change-Id: I19e5d932524209ed8b22ff2879fbff81519f4fde

networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/service/NetworkModelService.java
renderer/src/main/java/org/opendaylight/transportpce/renderer/NetworkModelWavelengthService.java
renderer/src/main/java/org/opendaylight/transportpce/renderer/provisiondevice/tasks/RollbackProcessor.java
servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/service/ServiceDataStoreOperations.java

index 3a02d7b715c11feaeaad2cce27d5a2820e395c61..e4944edb8846df482d337096e4598d184cf5f516 100644 (file)
@@ -20,9 +20,9 @@ public interface NetworkModelService {
      * Create new OpenROADM node in all OpenROADM topologies.
      *
      * @param nodeId
-     *   unique node ID of new OpenROADM node
+     *     unique node ID of new OpenROADM node
      * @param nodeVersion
-     *   OpenROADM node version
+     *     OpenROADM node version
      */
     void createOpenRoadmNode(String nodeId, String nodeVersion);
 
@@ -30,7 +30,7 @@ public interface NetworkModelService {
      * Delete OpenROADM node mapping and topologies.
      *
      * @param nodeId
-     *   unique node ID of OpenROADM node.
+     *     unique node ID of OpenROADM node.
      *
      */
     void deleteOpenRoadmnode(String nodeId);
@@ -39,9 +39,9 @@ public interface NetworkModelService {
      * Set/update connection status of OpenROADM node.
      *
      * @param nodeId
-     *   unique node ID of new OpenROADM node
+     *     unique node ID of new OpenROADM node
      * @param connectionStatus
-     *   connection status of the node
+     *     connection status of the node
      */
     void setOpenRoadmNodeStatus(String nodeId, NetconfNodeConnectionStatus.ConnectionStatus connectionStatus);
 
@@ -49,15 +49,15 @@ public interface NetworkModelService {
      * create new otn link in otn-topology.
      *
      * @param nodeA
-     *   OpenROADM node ID for link termination point A
+     *     OpenROADM node ID for link termination point A
      * @param tpA
-     *   OpenROADM tp id on nodeA for link termination point A
+     *     OpenROADM tp id on nodeA for link termination point A
      * @param nodeZ
-     *   OpenROADM node ID for link termination point Z
+     *     OpenROADM node ID for link termination point Z
      * @param tpZ
-     *   OpenROADM tp id on nodeZ for link termination point Z
+     *     OpenROADM tp id on nodeZ for link termination point Z
      * @param linkType
-     *   OtnLinkType, as OTU4, ODTU, etc
+     *     OtnLinkType, as OTU4, ODTU, etc
      */
     void createOtnLinks(String nodeA, String tpA, String nodeZ, String tpZ, OtnLinkType linkType);
 
@@ -65,15 +65,15 @@ public interface NetworkModelService {
      * delete otn links from otn-topology.
      *
      * @param nodeA
-     *   OpenROADM node ID for link termination point A
+     *     OpenROADM node ID for link termination point A
      * @param tpA
-     *   OpenROADM tp id on nodeA for link termination point A
+     *     OpenROADM tp id on nodeA for link termination point A
      * @param nodeZ
-     *   OpenROADM node ID for link termination point Z
+     *     OpenROADM node ID for link termination point Z
      * @param tpZ
-     *   OpenROADM tp id on nodeZ for link termination point Z
+     *     OpenROADM tp id on nodeZ for link termination point Z
      * @param linkType
-     *   OtnLinkType, as OTU4, ODTU, etc
+     *     OtnLinkType, as OTU4, ODTU, etc
      */
     void deleteOtnLinks(String nodeA, String tpA, String nodeZ, String tpZ, OtnLinkType linkType);
 
@@ -81,16 +81,16 @@ public interface NetworkModelService {
      * update otn links from otn-topology.
      *
      * @param nodeTps
-     *   List containing a string composed of the netconf nodeId , and the
+     *     List containing a string composed of the netconf nodeId , and the
      *       termination point supporting the service
      * @param serviceRate
-     *   Service rate may be 1G, 10G or 100G
+     *     Service rate may be 1G, 10G or 100G
      * @param tribPortNb
-     *   Trib port number allocated by the service
+     *     Trib port number allocated by the service
      * @param tribSoltNb
-     *   First trib slot number allocated by the service
+     *     First trib slot number allocated by the service
      * @param isDeletion
-     *   True indicates if the low-order otn service must be deleted
+     *       True indicates if the low-order otn service must be deleted
      */
     void updateOtnLinks(List<String> nodeTps, String serviceRate, Short tribPortNb, Short tribSoltNb,
         boolean isDeletion);
index 235faacbf36382cb668df818bb563eaf83bda569..ffe974ded40d5d3ed571d9e020553e95dc423369 100644 (file)
@@ -15,7 +15,7 @@ public interface NetworkModelWavelengthService {
      * Remove wavelength from available and add it to used wavelength list.
      *
      * @param pathDescription
-     *   path description containing a-to-z and z-to-a path
+     *     path description containing a-to-z and z-to-a path
      */
     void useWavelengths(PathDescription pathDescription);
 
@@ -23,7 +23,7 @@ public interface NetworkModelWavelengthService {
      * Remove wavelength from used and add it to available wavelength list.
      *
      * @param pathDescription
-     *   path description containing a-to-z and z-to-a path
+     *     path description containing a-to-z and z-to-a path
      */
     void freeWavelengths(PathDescription pathDescription);
 
index d4d53b522699becac1dfe3c22510f092823ff3eb..667152b6b1253a42e34cfcd560511418fa6da010 100644 (file)
@@ -41,7 +41,7 @@ public class RollbackProcessor {
      * Check if any previously added task requires rollback.
      * Rollback is necessary if just single task requires rollback.
      * @return
-     *   true if any of added tasks requires rollback. false if none of added tasks requires rollback.
+     *     true if any of added tasks requires rollback. false if none of added tasks requires rollback.
      */
     public boolean isRollbackNecessary() {
         for (RollbackTask task: this.tasks) {
@@ -57,7 +57,7 @@ public class RollbackProcessor {
      * It does not matter if any of the tasks requires rollback.
      * All previously added tasks will be rolled back and removed from this processor.
      * @return
-     *   number of tasks rolled back
+     *     number of tasks rolled back
      */
     @SuppressWarnings("checkstyle:IllegalCatch")
     public int rollbackAll() {
@@ -80,7 +80,7 @@ public class RollbackProcessor {
      * Rollback all tasks in case any task has failed.
      * If rollback is necessary, all previously added tasks will be rolled back and removed from this processor.
      * @return
-     *   number of tasks rolled back
+     *     number of tasks rolled back
      */
     public int rollbackAllIfNecessary() {
         if (!isRollbackNecessary()) {
index 72018c20778a175110c0e567c380d5578e62ead0..86e36ac09db38c0873955a72d446b98832a436e6 100644 (file)
@@ -31,7 +31,7 @@ public interface ServiceDataStoreOperations {
      * get service by name.
      *
      * @param serviceName
-     *   unique name of the service
+     *     unique name of the service
      * @return Optional of Services
      */
     Optional<Services> getService(String serviceName);
@@ -40,7 +40,7 @@ public interface ServiceDataStoreOperations {
      * get temp service by common-id.
      *
      * @param commonId
-     *   unique common-id of the service
+     *     unique common-id of the service
      * @return Optional of Services
      */
     Optional<org.opendaylight.yang.gen.v1.http.org.openroadm.service.rev190531.temp.service.list
@@ -50,7 +50,7 @@ public interface ServiceDataStoreOperations {
      * deleteService service by name.
      *
      * @param serviceName
-     *   unique name of the service
+     *     unique name of the service
      * @return result of Delete operation
      */
     OperationResult deleteService(String serviceName);
@@ -59,7 +59,7 @@ public interface ServiceDataStoreOperations {
      * deleteService service by common-id.
      *
      * @param commonId
-     *   unique common-id of the service
+     *     unique common-id of the service
      * @return result of Delete operation
      */
     OperationResult deleteTempService(String commonId);
@@ -68,11 +68,11 @@ public interface ServiceDataStoreOperations {
      * modifyService service attributes.
      *
      * @param serviceName
-     *   unique name of the service
+     *     unique name of the service
      * @param operationalState
-     *   operational state of service
+     *     operational state of service
      * @param administrativeState
-     *   administrative state of service
+     *     administrative state of service
      * @return result of modifyService operation
      */
     OperationResult modifyService(String serviceName, State operationalState, AdminStates administrativeState);
@@ -99,9 +99,9 @@ public interface ServiceDataStoreOperations {
      * create new servicePath entry.
      *
      * @param serviceInput
-     *   ServiceInput data for creation of service
+     *     ServiceInput data for creation of service
      * @param outputFromPce
-     *   output from pce request which is used as input for creating of service.
+     *     output from pce request which is used as input for creating of service.
      * @return result of createServicePath operation
      */
     OperationResult createServicePath(ServiceInput serviceInput, PathComputationRequestOutput outputFromPce);
@@ -119,7 +119,7 @@ public interface ServiceDataStoreOperations {
      * deleteServicePath by name.
      *
      * @param serviceName
-     *   unique name of the service
+     *     unique name of the service
      * @return result of Delete operation
      */
     OperationResult deleteServicePath(String serviceName);
@@ -129,7 +129,7 @@ public interface ServiceDataStoreOperations {
      * This method exists only for backwards compatibility. It will be deleted once refactoring is done.
      *
      * @param serviceName
-     *   unique name of the service
+     *     unique name of the service
      * @param input ServiceCreateInput data
      * @param output PathComputationRequestOutput data
      * @param choice 0:modify, 1:delete, 2:write