From: guillaume.lambert Date: Fri, 10 Jan 2020 16:15:51 +0000 (+0100) Subject: fix javadoc warnings X-Git-Tag: 1.0.0~42 X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=transportpce.git;a=commitdiff_plain;h=184fea2328ad4306029dad116b0297aabc1f98e3;hp=9379d4243e3a40073131310770adad4537ad1dff fix javadoc warnings Signed-off-by: guillaume.lambert Change-Id: Ic5a9edce2ed0ee0beb887a8b617ea0ef97b478b5 --- diff --git a/inventory/src/main/java/org/opendaylight/transportpce/inventory/utils/StringUtils.java b/inventory/src/main/java/org/opendaylight/transportpce/inventory/utils/StringUtils.java index 7f2031ada..443988f48 100644 --- a/inventory/src/main/java/org/opendaylight/transportpce/inventory/utils/StringUtils.java +++ b/inventory/src/main/java/org/opendaylight/transportpce/inventory/utils/StringUtils.java @@ -65,6 +65,9 @@ public final class StringUtils { /** * Checks if the given object is null and returns its representation given by replacement. * + * @param objectString an object + * @param replacement a replacement string + * @return a string representing the object */ public static String prepareString(Object objectString, String replacement) { return objectString == null ? replacement : objectString.toString(); @@ -73,6 +76,8 @@ public final class StringUtils { /** * Checks if the given object is null and returns -1 . * + * @param object an object + * @return a string representing the object or -1 if null */ public static String prepareEmptyInt(Object object) { return (object == null ? "-1" : object.toString()); diff --git a/pce/src/main/java/org/opendaylight/transportpce/pce/gnpy/GnpyResult.java b/pce/src/main/java/org/opendaylight/transportpce/pce/gnpy/GnpyResult.java index 6d7e4a946..50e2b7c8d 100644 --- a/pce/src/main/java/org/opendaylight/transportpce/pce/gnpy/GnpyResult.java +++ b/pce/src/main/java/org/opendaylight/transportpce/pce/gnpy/GnpyResult.java @@ -262,6 +262,12 @@ public class GnpyResult { /** * Transforms the given input {@link NormalizedNode} into the given {@link DataObject}. + * + * @param a generic + * @param normalizedNode a non null representation of the normalizedNode + * @param rootNode root node + * @param codecRegistry codec registry + * @return value of the binding Node Entry */ @SuppressWarnings("unchecked") public Optional getDataObject(@Nonnull NormalizedNode normalizedNode,