Map system-ordered leaf-lists to Set<T>

[mdsal.git] / binding / yang-binding / src / main / java / org / opendaylight / yangtools / yang / binding / CodeHelpers.java

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 cbdec28633bcb821483ff24f09c0038695c493fd..b378a703ba86e688acb52e01afef817f51d5b333 100644 (file)
--- 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
@@ -16,10 +16,12 @@ import com.google.common.base.VerifyException;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
 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;
@@ -114,10 +116,28 @@ public final class CodeHelpers {
      */
     public static void appendValue(final ToStringHelper helper, final String name, final byte[] value) {
         if (value != null) {
+            // FIXME: MDSAL-692: use hex-encoding instead
             helper.add(name, Arrays.toString(value));
         }
     }
 
+    /**
+     * 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.
@@ -193,6 +213,7 @@ public final class CodeHelpers {
      * @throws IllegalArgumentException always
      */
     public static void throwInvalidLength(final String expected, final byte[] actual) {
+        // FIXME: MDSAL-692: use hex-encoding instead
         throwInvalidLength(expected, Arrays.toString(actual));
     }
 
@@ -367,21 +388,44 @@ public final class CodeHelpers {
      * @param requiredClass Required item 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 instance of {@code requiredItemClass}
      * @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 target list 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;
+    }
+
+    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)
                     + "\"", e);
             }
         }
-        return (List<T>) list;
     }
 
     /**