From 330dac43741151d70ef1fe941c4d53918c23aff4 Mon Sep 17 00:00:00 2001 From: Gilles Thouenon Date: Fri, 10 Jul 2020 12:23:40 +0200 Subject: [PATCH] Fix javadoc issue Signed-off-by: Gilles Thouenon Change-Id: I19e5d932524209ed8b22ff2879fbff81519f4fde --- .../service/NetworkModelService.java | 40 +++++++++---------- .../NetworkModelWavelengthService.java | 4 +- .../tasks/RollbackProcessor.java | 6 +-- .../service/ServiceDataStoreOperations.java | 22 +++++----- 4 files changed, 36 insertions(+), 36 deletions(-) diff --git a/networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/service/NetworkModelService.java b/networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/service/NetworkModelService.java index 3a02d7b71..e4944edb8 100644 --- a/networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/service/NetworkModelService.java +++ b/networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/service/NetworkModelService.java @@ -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 nodeTps, String serviceRate, Short tribPortNb, Short tribSoltNb, boolean isDeletion); diff --git a/renderer/src/main/java/org/opendaylight/transportpce/renderer/NetworkModelWavelengthService.java b/renderer/src/main/java/org/opendaylight/transportpce/renderer/NetworkModelWavelengthService.java index 235faacbf..ffe974ded 100644 --- a/renderer/src/main/java/org/opendaylight/transportpce/renderer/NetworkModelWavelengthService.java +++ b/renderer/src/main/java/org/opendaylight/transportpce/renderer/NetworkModelWavelengthService.java @@ -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); diff --git a/renderer/src/main/java/org/opendaylight/transportpce/renderer/provisiondevice/tasks/RollbackProcessor.java b/renderer/src/main/java/org/opendaylight/transportpce/renderer/provisiondevice/tasks/RollbackProcessor.java index d4d53b522..667152b6b 100644 --- a/renderer/src/main/java/org/opendaylight/transportpce/renderer/provisiondevice/tasks/RollbackProcessor.java +++ b/renderer/src/main/java/org/opendaylight/transportpce/renderer/provisiondevice/tasks/RollbackProcessor.java @@ -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()) { diff --git a/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/service/ServiceDataStoreOperations.java b/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/service/ServiceDataStoreOperations.java index 72018c207..86e36ac09 100644 --- a/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/service/ServiceDataStoreOperations.java +++ b/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/service/ServiceDataStoreOperations.java @@ -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 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