From 85ff3a07c50536fca00a6090e59c63396d58626f Mon Sep 17 00:00:00 2001 From: "guillaume.lambert" Date: Tue, 4 Sep 2018 15:49:54 +0200 Subject: [PATCH] fix more javadocs warnings Change-Id: Ic03ee472e01b7d229759fb2c5fca93c44b7332b2 Signed-off-by: guillaume.lambert (cherry picked from commit aa5b53b863a5a699d32febadc3345baa4038a653) --- .../openroadminterfaces/OpenRoadmInterfaces.java | 2 ++ .../transportpce/pce/PceManyTests.java | 2 ++ .../transportpce/pce/utils/PceTestData.java | 4 ++++ .../OpenRoadmInterfaceFactory.java | 1 + .../checks/CheckCoherencyHardSoft.java | 3 +++ .../checks/ServicehandlerCompliancyCheck.java | 16 ++++++++++++---- .../checks/ServicehandlerTxRxCheck.java | 2 ++ 7 files changed, 26 insertions(+), 4 deletions(-) diff --git a/common/src/main/java/org/opendaylight/transportpce/common/openroadminterfaces/OpenRoadmInterfaces.java b/common/src/main/java/org/opendaylight/transportpce/common/openroadminterfaces/OpenRoadmInterfaces.java index d0bc45e95..fa45f1913 100644 --- a/common/src/main/java/org/opendaylight/transportpce/common/openroadminterfaces/OpenRoadmInterfaces.java +++ b/common/src/main/java/org/opendaylight/transportpce/common/openroadminterfaces/OpenRoadmInterfaces.java @@ -43,6 +43,8 @@ public interface OpenRoadmInterfaces { * @param nodeId node ID * @param circuitPackName Circtuit-Pack name * @param activate activate or not + * + * @throws OpenRoadmInterfaceException OpenRoadm Interface Exception */ void postEquipmentState(String nodeId, String circuitPackName, boolean activate) throws OpenRoadmInterfaceException; diff --git a/pce/src/test/java/org/opendaylight/transportpce/pce/PceManyTests.java b/pce/src/test/java/org/opendaylight/transportpce/pce/PceManyTests.java index ef1e5d419..5575e4722 100644 --- a/pce/src/test/java/org/opendaylight/transportpce/pce/PceManyTests.java +++ b/pce/src/test/java/org/opendaylight/transportpce/pce/PceManyTests.java @@ -47,6 +47,8 @@ public class PceManyTests extends AbstractTest { * expected path computation result * @param topologyDataPath * path to topology data file to be used for DataStore population + * + * @throws Exception exception throws by the function */ public PceManyTests(PathComputationRequestInput input, PathComputationRequestOutput expectedOutput, String topologyDataPath) throws Exception { diff --git a/pce/src/test/java/org/opendaylight/transportpce/pce/utils/PceTestData.java b/pce/src/test/java/org/opendaylight/transportpce/pce/utils/PceTestData.java index 0e1394e4f..d4747a53f 100644 --- a/pce/src/test/java/org/opendaylight/transportpce/pce/utils/PceTestData.java +++ b/pce/src/test/java/org/opendaylight/transportpce/pce/utils/PceTestData.java @@ -223,6 +223,8 @@ public final class PceTestData { /** * Generate Data for Test 1 result 5-4. + * @param wl WaveLength + * * @return output PathComputationRequestOutput data */ public static PathComputationRequestOutput getPCE_test_result_54(Long wl) { @@ -466,6 +468,8 @@ public final class PceTestData { "pce:pce-metric": "hop-count" } } + * @param base Path Computation Request Input base + * * @return input PathComputationRequestInput data */ public static PathComputationRequestInput build_diversity_from_request(PathComputationRequestInput base) { diff --git a/renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterfaceFactory.java b/renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterfaceFactory.java index 734c6e581..5d3b2a86e 100644 --- a/renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterfaceFactory.java +++ b/renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterfaceFactory.java @@ -219,6 +219,7 @@ public class OpenRoadmInterfaceFactory { * * * @return Name of the interface if successful, otherwise return null. + * @throws OpenRoadmInterfaceException OpenRoadmInterfaceException */ public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface) diff --git a/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/CheckCoherencyHardSoft.java b/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/CheckCoherencyHardSoft.java index a9a2d80b2..f3c015a04 100644 --- a/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/CheckCoherencyHardSoft.java +++ b/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/CheckCoherencyHardSoft.java @@ -23,6 +23,9 @@ public final class CheckCoherencyHardSoft { /** * function to check coherency between hard and soft constraints. + * @param hard Hard Constraints + * @param soft Soft Constraints + * * @return true if coherent * false else */ diff --git a/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/ServicehandlerCompliancyCheck.java b/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/ServicehandlerCompliancyCheck.java index 72995e6ba..0ee2ba8f7 100644 --- a/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/ServicehandlerCompliancyCheck.java +++ b/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/ServicehandlerCompliancyCheck.java @@ -35,16 +35,24 @@ public final class ServicehandlerCompliancyCheck { /** * Check Compliancy of Service request. * + * @param serviceName + * Service Name + * @param sdncRequestHeader + * sdncRequestHeader + * @param conType + * Connection type + * @param action + * RPC Actions * @param contype * Boolean to check connection Type - * @param sndcRequest - * Boolean to check sndcRequestHeader + * @param sdncRequest + * Boolean to check sdncRequestHeader * * @return true if String ok false if not */ public static ComplianceCheckResult check(String serviceName, SdncRequestHeader sdncRequestHeader, ConnectionType conType, RpcActions action, - Boolean contype, Boolean sndcRequest) { + Boolean contype, Boolean sdncRequest) { boolean result = true; String message = ""; if (!checkString(serviceName)) { @@ -54,7 +62,7 @@ public final class ServicehandlerCompliancyCheck { result = false; message = "Service ConnectionType is not set"; } - if (sndcRequest) { + if (sdncRequest) { if (sdncRequestHeader != null) { RpcActions serviceAction = sdncRequestHeader.getRpcAction(); String requestId = sdncRequestHeader.getRequestId(); diff --git a/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/ServicehandlerTxRxCheck.java b/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/ServicehandlerTxRxCheck.java index 367e26dc1..e55cf5cdc 100644 --- a/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/ServicehandlerTxRxCheck.java +++ b/servicehandler/src/main/java/org/opendaylight/transportpce/servicehandler/validation/checks/ServicehandlerTxRxCheck.java @@ -124,6 +124,8 @@ public final class ServicehandlerTxRxCheck { /** * Check Compliancy of Service TxRx info. + * @param serviceEnd Service Endpoint + * @param endpointType Endpoint type * * @return true if String ok false if not */ -- 2.36.6