fix javadoc warnings 44/86844/1
authorguillaume.lambert <guillaume.lambert@orange.com>
Fri, 10 Jan 2020 16:15:51 +0000 (17:15 +0100)
committerguillaume.lambert <guillaume.lambert@orange.com>
Fri, 10 Jan 2020 16:15:51 +0000 (17:15 +0100)
Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: Ic5a9edce2ed0ee0beb887a8b617ea0ef97b478b5

inventory/src/main/java/org/opendaylight/transportpce/inventory/utils/StringUtils.java
pce/src/main/java/org/opendaylight/transportpce/pce/gnpy/GnpyResult.java

index 7f2031ada73ee6fb993aa69bcfec39e10b7d7b61..443988f483e31609ba433e6e9857be65abb64d42 100644 (file)
@@ -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());
index 6d7e4a946e32560350d38e1ea0877710a27dc6c5..50e2b7c8d9e517d932a29ac64fb3e8185f617285 100644 (file)
@@ -262,6 +262,12 @@ public class GnpyResult {
 
     /**
      * Transforms the given input {@link NormalizedNode} into the given {@link DataObject}.
+     *
+     * @param <T> 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 <T extends DataObject> Optional<T> getDataObject(@Nonnull NormalizedNode<?, ?> normalizedNode,