X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=binding%2Fyang-binding%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Fyang%2Fbinding%2FCodeHelpers.java;h=ff57748811c94c48270d5c81aba46ed3b6c67b98;hb=f735dcbc86962f6b51abecadec0c00f595649984;hp=8de4954d319ea292de6f87177f04bc64533afedf;hpb=fcdaa3a63fe28857a2645c138cf617dc998ad20e;p=mdsal.git

diff --git a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/CodeHelpers.java b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/CodeHelpers.java
index 8de4954d31..ff57748811 100644
--- a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/CodeHelpers.java
+++ b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/CodeHelpers.java
@@ -15,11 +15,14 @@ import com.google.common.base.MoreObjects.ToStringHelper;
 import com.google.common.base.VerifyException;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import java.util.Arrays;
+import java.util.Collection;
 import java.util.List;
 import java.util.Map;
 import java.util.NoSuchElementException;
 import java.util.Objects;
+import java.util.Set;
 import java.util.regex.Pattern;
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.Nullable;
@@ -119,6 +122,23 @@ public final class CodeHelpers {
         }
     }
 
+    /**
+     * Append augmentation map of an Augmentable to a ToStringHelper. If augmentations are null or empt, this method
+     * does nothing.
+     *
+     * @param helper Helper to append to
+     * @param name Name of the augmentation value
+     * @param augmentable Augmentable object to
+     * @throws NullPointerException if any argument is null
+     */
+    public static void appendAugmentations(final ToStringHelper helper, final String name,
+            final Augmentable<?> augmentable) {
+        final var augments = augmentable.augmentations();
+        if (!augments.isEmpty()) {
+            helper.add(name, augments.values());
+        }
+    }
+
     /**
      * Compile a list of pattern regular expressions and return them as an array. The list must hold at least two
      * expressions.
@@ -363,27 +383,125 @@ public final class CodeHelpers {
         }
     }
 
+    /**
+     * Utility method for checking whether a target object is compatible with a particular identity class.
+     *
+     * @param requiredClass Required class
+     * @param fieldName name of the field being filled
+     * @param obj Object to check, may be null
+     * @return Object cast to required class, if it class matches requirement, or null
+     * @throws IllegalArgumentException if {@code obj} is not an Class representing {@code requiredClass}
+     * @throws NullPointerException if {@code requiredClass} or {@code fieldName} is null
+     */
+    public static <T extends BaseIdentity> @Nullable Class<? extends T> checkFieldCastIdentity(
+            final @NonNull Class<T> requiredClass, final @NonNull String fieldName, final @Nullable Object obj) {
+        if (obj == null) {
+            return null;
+        }
+        checkArgument(obj instanceof Class, "Invalid input value \"%s\" for property \"%s\"", obj, fieldName);
+
+        try {
+            return ((Class<?>) obj).asSubclass(requiredClass);
+        } catch (ClassCastException e) {
+            throw new IllegalArgumentException("Invalid input value \"" + obj + "\" for property \"" + fieldName + "\"",
+                e);
+        }
+    }
+
     /**
      * Utility method for checking whether the items of target list is compatible.
      *
      * @param requiredClass Required item class
      * @param fieldName name of the field being filled
      * @param list List, which items should be checked
-     * @throws IllegalArgumentException if a list item is not instance of {@code requiredItemClass}
+     * @return Type-checked List
+     * @throws IllegalArgumentException if a list item is not instance of {@code requiredClass}
      * @throws NullPointerException if {@code requiredClass} or {@code fieldName} is null
      */
     @SuppressWarnings("unchecked")
     public static <T> @Nullable List<T> checkListFieldCast(final @NonNull Class<?> requiredClass,
             final @NonNull String fieldName, final @Nullable List<?> list) {
-        if (list != null) {
+        checkCollectionField(requiredClass, fieldName, list);
+        return (List<T>) list;
+    }
+
+    /**
+     * Utility method for checking whether the items of a target list are compatible with a particular identity class.
+     *
+     * @param requiredClass Required class
+     * @param fieldName name of the field being filled
+     * @param list List, which items should be checked
+     * @return Type-checked List
+     * @throws IllegalArgumentException if a list item is not a Class representing {@code requiredClass}
+     * @throws NullPointerException if {@code requiredClass} or {@code fieldName} is null
+     */
+    @SuppressWarnings("unchecked")
+    public static <T extends BaseIdentity> @Nullable List<Class<? extends T>> checkListFieldCastIdentity(
+            final @NonNull Class<T> requiredClass, final @NonNull String fieldName, final @Nullable List<?> list) {
+        checkCollectionFieldIdentity(requiredClass, fieldName, list);
+        return (List<Class<? extends T>>) list;
+    }
+
+    /**
+     * Utility method for checking whether the items of target set is compatible.
+     *
+     * @param requiredClass Required item class
+     * @param fieldName name of the field being filled
+     * @param set Set, which items should be checked
+     * @return Type-checked Set
+     * @throws IllegalArgumentException if a set item is not instance of {@code requiredItemClass}
+     * @throws NullPointerException if {@code requiredClass} or {@code fieldName} is null
+     */
+    @SuppressWarnings("unchecked")
+    public static <T> @Nullable Set<T> checkSetFieldCast(final @NonNull Class<?> requiredClass,
+            final @NonNull String fieldName, final @Nullable Set<?> set) {
+        checkCollectionField(requiredClass, fieldName, set);
+        return (Set<T>) set;
+    }
+
+    /**
+     * Utility method for checking whether the items of a target set are compatible with a particular identity class.
+     *
+     * @param requiredClass Required class
+     * @param fieldName name of the field being filled
+     * @param set Set, which items should be checked
+     * @return Type-checked Set
+     * @throws IllegalArgumentException if a set item is not a Class representing {@code requiredClass}
+     * @throws NullPointerException if {@code requiredClass} or {@code fieldName} is null
+     */
+    @SuppressWarnings("unchecked")
+    public static <T extends BaseIdentity> @Nullable Set<Class<? extends T>> checkSetFieldCastIdentity(
+            final @NonNull Class<T> requiredClass, final @NonNull String fieldName, final @Nullable Set<?> set) {
+        checkCollectionFieldIdentity(requiredClass, fieldName, set);
+        return (Set<Class<? extends T>>) set;
+    }
+
+    @SuppressFBWarnings(value = "DCN_NULLPOINTER_EXCEPTION",
+        justification = "Internal NPE->IAE conversion")
+    private static void checkCollectionField(final @NonNull Class<?> requiredClass,
+            final @NonNull String fieldName, final @Nullable Collection<?> collection) {
+        if (collection != null) {
             try {
-                list.forEach(item -> requiredClass.cast(requireNonNull(item)));
+                collection.forEach(item -> requiredClass.cast(requireNonNull(item)));
             } catch (ClassCastException | NullPointerException e) {
-                throw new IllegalArgumentException("Invalid input list item for property \"" + requireNonNull(fieldName)
+                throw new IllegalArgumentException("Invalid input item for property \"" + requireNonNull(fieldName)
+                    + "\"", e);
+            }
+        }
+    }
+
+    @SuppressFBWarnings(value = "DCN_NULLPOINTER_EXCEPTION",
+        justification = "Internal NPE->IAE conversion")
+    private static void checkCollectionFieldIdentity(final @NonNull Class<?> requiredClass,
+            final @NonNull String fieldName, final @Nullable Collection<?> collection) {
+        if (collection != null) {
+            try {
+                collection.forEach(item -> ((Class<?>) item).asSubclass(requiredClass));
+            } catch (ClassCastException | NullPointerException e) {
+                throw new IllegalArgumentException("Invalid input item for property \"" + requireNonNull(fieldName)
                     + "\"", e);
             }
         }
-        return (List<T>) list;
     }
 
     /**