Specialize relative leafref types during instantiation
[mdsal.git] / binding / yang-binding / src / main / java / org / opendaylight / yangtools / yang / binding / CodeHelpers.java
index 2dd7ac1674c302dbd93cf2997dca7a6e257437a2..50c77d9134dcc287b021488cb1c7c8ccdbdf6f42 100644 (file)
@@ -16,6 +16,7 @@ import com.google.common.base.VerifyException;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.Maps;
+import java.math.BigInteger;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Map;
@@ -23,6 +24,10 @@ import java.util.Objects;
 import java.util.regex.Pattern;
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.yangtools.yang.common.Uint16;
+import org.opendaylight.yangtools.yang.common.Uint32;
+import org.opendaylight.yangtools.yang.common.Uint64;
+import org.opendaylight.yangtools.yang.common.Uint8;
 
 /**
  * Helper methods for generated binding code. This class concentrates useful primitives generated code may call
@@ -48,13 +53,28 @@ public final class CodeHelpers {
         checkArgument(expression, "expected one of: %s \n%but was: %s", options, value);
     }
 
+    /**
+     * A shortcut for {@code Preconditions.checkNotNull(value, "Key component \"%s\" must not be null", name)}.
+     *
+     * @param value Value itself
+     * @param name Name of the value
+     * @return Non-null value
+     * @throws NullPointerException if value is null
+     */
+    public static <T> @NonNull T requireKeyProp(final @Nullable T value, final @NonNull String name) {
+        if (value == null) {
+            throw new NullPointerException("Key component \"" + name + "\" may not be null");
+        }
+        return value;
+    }
+
     /**
      * A shortcut for {@code Objects.requireNonNull(value, "Supplied value may not be null")}.
      *
      * @param value Value itself
      * @throws NullPointerException if value is null
      */
-    public static void requireValue(@Nullable final Object value) {
+    public static void requireValue(final @Nullable Object value) {
         requireNonNull(value, "Supplied value may not be null");
     }
 
@@ -315,6 +335,122 @@ public final class CodeHelpers {
         return wrapHashCode(Arrays.hashCode(obj));
     }
 
+    /**
+     * Compatibility utility for converting a legacy {@link Short} {@code uint8} value to its {@link Uint8}
+     * counterpart.
+     *
+     * @param value Legacy value
+     * @return Converted value
+     * @throws IllegalArgumentException if the value does not fit an Uint8
+     * @deprecated This method is provided for migration purposes only, do not use it outside of deprecated
+     *             compatibility methods.
+     */
+    @Deprecated
+    public static @Nullable Uint8 compatUint(final @Nullable Short value) {
+        return value == null ? null : Uint8.valueOf(value.shortValue());
+    }
+
+    /**
+     * Compatibility utility for converting a legacy {@link Integer} {@code uint16} value to its {@link Uint16}
+     * counterpart.
+     *
+     * @param value Legacy value
+     * @return Converted value
+     * @throws IllegalArgumentException if the value does not fit an Uint16
+     * @deprecated This method is provided for migration purposes only, do not use it outside of deprecated
+     *             compatibility methods.
+     */
+    @Deprecated
+    public static @Nullable Uint16 compatUint(final @Nullable Integer value) {
+        return value == null ? null : Uint16.valueOf(value.intValue());
+    }
+
+    /**
+     * Compatibility utility for converting a legacy {@link Long} {@code uint32} value to its {@link Uint32}
+     * counterpart.
+     *
+     * @param value Legacy value
+     * @return Converted value
+     * @throws IllegalArgumentException if the value does not fit an Uint32
+     * @deprecated This method is provided for migration purposes only, do not use it outside of deprecated
+     *             compatibility methods.
+     */
+    @Deprecated
+    public static @Nullable Uint32 compatUint(final @Nullable Long value) {
+        return value == null ? null : Uint32.valueOf(value.longValue());
+    }
+
+    /**
+     * Compatibility utility for converting a legacy {@link BigInteger} {@code uint64} value to its {@link Uint64}
+     * counterpart.
+     *
+     * @param value Legacy value
+     * @return Converted value
+     * @throws IllegalArgumentException if the value does not fit an Uint64
+     * @deprecated This method is provided for migration purposes only, do not use it outside of deprecated
+     *             compatibility methods.
+     */
+    @Deprecated
+    public static @Nullable Uint64 compatUint(final @Nullable BigInteger value) {
+        return value == null ? null : Uint64.valueOf(value);
+    }
+
+    /**
+     * Utility method for checking whether a target object is a compatible DataObject.
+     *
+     * @param requiredClass Required DataObject class
+     * @param obj Object to check, may be null
+     * @return Object cast to required class, if its implemented class matches requirement, null otherwise
+     * @throws NullPointerException if {@code requiredClass} is null
+     */
+    public static <T extends DataObject> @Nullable T checkCast(final @NonNull Class<T> requiredClass,
+            final @Nullable Object obj) {
+        return obj instanceof DataObject && requiredClass.equals(((DataObject) obj).implementedInterface())
+            ? requiredClass.cast(obj) : null;
+    }
+
+    /**
+     * Utility method for checking whether a target object is compatible.
+     *
+     * @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 its class matches requirement, or null
+     * @throws IllegalArgumentException if {@code obj} is not an instance of {@code requiredClass}
+     * @throws NullPointerException if {@code requiredClass} or {@code fieldName} is null
+     */
+    public static <T> @Nullable T checkFieldCast(final @NonNull Class<T> requiredClass, final @NonNull String fieldName,
+            final @Nullable Object obj) {
+        try {
+            return requiredClass.cast(obj);
+        } catch (ClassCastException e) {
+            throw new IllegalArgumentException("Invalid input value 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}
+     * @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) {
+            try {
+                list.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;
+    }
+
     /**
      * The constant '31' is the result of folding this code:
      * <pre>