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=e12cb35a88b4a4883a9072f7c19842ee99b05c53;hb=refs%2Fchanges%2F35%2F100935%2F5;hp=c51ce89361336afc47a875bea303109126464052;hpb=6e761bf2a697fffea66c38cd8c315a8bac8c8ae2;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 c51ce89361..e12cb35a88 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,19 +15,18 @@ 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 com.google.common.collect.Maps; -import java.math.BigInteger; +import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import java.util.Arrays; +import java.util.Collection; +import java.util.HexFormat; 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; -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 @@ -53,13 +52,44 @@ public final class CodeHelpers { checkArgument(expression, "expected one of: %s \n%but was: %s", options, value); } + /** + * Return value and check whether specified value is null and if so throws exception. This method supports + * require default getter methods. + * + * @param value Value itself + * @param name Name of the value + * @return Non-null value + * @throws NoSuchElementException if value is null + */ + public static @NonNull T require(final @Nullable T value, final @NonNull String name) { + if (value == null) { + throw new NoSuchElementException("Value of " + name + " is not present"); + } + return 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 @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"); } @@ -88,7 +118,24 @@ public final class CodeHelpers { */ public static void appendValue(final ToStringHelper helper, final String name, final byte[] value) { if (value != null) { - helper.add(name, Arrays.toString(value)); + helper.add(name, HexFormat.of().formatHex(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()); } } @@ -167,7 +214,7 @@ public final class CodeHelpers { * @throws IllegalArgumentException always */ public static void throwInvalidLength(final String expected, final byte[] actual) { - throwInvalidLength(expected, Arrays.toString(actual)); + throwInvalidLength(expected, HexFormat.of().formatHex(actual)); } /** @@ -278,24 +325,6 @@ public final class CodeHelpers { return input != null && input.isEmpty() ? null : input; } - /** - * Compatibility utility for turning a List of identifiable objects to an indexed map. - * - * @param key type - * @param identifiable type - * @param list legacy list - * @return Indexed map - * @throws IllegalArgumentException if the list contains entries with the same key - * @throws NullPointerException if the list contains a null entry - * @deprecated This method is a transitional helper used only in methods deprecated themselves. - */ - // FIXME: MDSAL-540: remove this method - @Deprecated - public static , V extends Identifiable> @Nullable Map compatMap( - final @Nullable List list) { - return list == null || list.isEmpty() ? null : Maps.uniqueIndex(list, Identifiable::key); - } - /** * Return hash code of a single-property wrapper class. Since the wrapper is not null, we really want to discern * this object being present, hence {@link Objects#hashCode()} is not really useful we would end up with {@code 0} @@ -321,90 +350,134 @@ public final class CodeHelpers { } /** - * Compatibility utility for converting a legacy {@link Short} {@code uint8} value to its {@link Uint8} - * counterpart. + * The constant '31' is the result of folding this code: + * 
+     *   
+     *     final int prime = 31;
+     *     int result = 1;
+     *     result = result * prime + Objects.hashCode(obj);
+     *     return result;
+     *   
+     *
+ * when hashCode is returned as 0, such as due to obj being null or its hashCode being 0. * - * @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. + * @param hash Wrapped object hash + * @return Wrapper object hash */ - @Deprecated - public static @Nullable Uint8 compatUint(final @Nullable Short value) { - return value == null ? null : Uint8.valueOf(value.shortValue()); + private static int wrapHashCode(final int hash) { + return hash == 0 ? 31 : hash; } /** - * Compatibility utility for converting a legacy {@link Integer} {@code uint16} value to its {@link Uint16} - * counterpart. + * Check that the specified {@link Enumeration} object is not {@code null}. This method is meant to be used with + * {@code ofName(String)} and {@code ofValue(int)} static factory methods. * - * @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. + * @param obj enumeration object, possibly null + * @param name User-supplied enumeration name + * @return Enumeration object + * @throws IllegalArgumentException if {@code obj} is null */ - @Deprecated - public static @Nullable Uint16 compatUint(final @Nullable Integer value) { - return value == null ? null : Uint16.valueOf(value.intValue()); + public static @NonNull T checkEnum(final @Nullable T obj, final String name) { + if (obj == null) { + throw new IllegalArgumentException("\"" + name + "\" is not a valid name"); + } + return obj; } /** - * Compatibility utility for converting a legacy {@link Long} {@code uint32} value to its {@link Uint32} - * counterpart. + * Check that the specified {@link Enumeration} object is not {@code null}. This method is meant to be used with + * {@code ofName(String)} and {@code ofValue(int)} static factory methods. * - * @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. + * @param obj enumeration object, possibly null + * @param value User-supplied enumeration value + * @return Enumeration object + * @throws IllegalArgumentException if {@code obj} is null */ - @Deprecated - public static @Nullable Uint32 compatUint(final @Nullable Long value) { - return value == null ? null : Uint32.valueOf(value.longValue()); + public static @NonNull T checkEnum(final @Nullable T obj, final int value) { + if (obj == null) { + throw new IllegalArgumentException(value + " is not a valid value"); + } + return obj; } /** - * Compatibility utility for converting a legacy {@link BigInteger} {@code uint64} value to its {@link Uint64} - * counterpart. + * Utility method for checking whether a target object is a compatible DataObject. * - * @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. + * @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 */ - @Deprecated - public static @Nullable Uint64 compatUint(final @Nullable BigInteger value) { - return value == null ? null : Uint64.valueOf(value); + public static @Nullable T checkCast(final @NonNull Class requiredClass, + final @Nullable Object obj) { + return obj instanceof DataObject && requiredClass.equals(((DataObject) obj).implementedInterface()) + ? requiredClass.cast(obj) : null; } /** - * Utility for extracting augmentations from an implementation of {@link AugmentationHolder} interface. + * Utility method for checking whether a target object is compatible. * - * @param obj Implementation object - * @return hash code of augmentations - * @throws NullPointerException if obj is null + * @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 int hashAugmentations(final @NonNull AugmentationHolder obj) { - return obj.augmentations().hashCode(); + public static @Nullable T checkFieldCast(final @NonNull Class 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); + } } /** - * The constant '31' is the result of folding this code: - * 
-     *     final int prime = 31;
-     *     int result = 1;
-     *     result = result * prime + Objects.hashCode(obj);
-     *     return result;
-     *
- * when hashCode is returned as 0, such as due to obj being null or its hashCode being 0. + * Utility method for checking whether the items of target list is compatible. * - * @param hash Wrapped object hash - * @return Wrapper object hash + * @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 requiredClass} + * @throws NullPointerException if {@code requiredClass} or {@code fieldName} is null */ - private static int wrapHashCode(final int hash) { - return hash == 0 ? 31 : hash; + @SuppressWarnings("unchecked") + public static @Nullable List checkListFieldCast(final @NonNull Class requiredClass, + final @NonNull String fieldName, final @Nullable List list) { + checkCollectionField(requiredClass, fieldName, list); + return (List) 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 @Nullable Set checkSetFieldCast(final @NonNull Class requiredClass, + final @NonNull String fieldName, final @Nullable Set set) { + checkCollectionField(requiredClass, fieldName, set); + return (Set) 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 { + collection.forEach(item -> requiredClass.cast(requireNonNull(item))); + } catch (ClassCastException | NullPointerException e) { + throw new IllegalArgumentException("Invalid input item for property \"" + requireNonNull(fieldName) + + "\"", e); + } + } } }