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=b7d8a8e48e6f0eb35962fef568c1f707d8b9ce34;hpb=ebf58dd99e4d7039ea2f3949aa762fbc990115b6;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 b7d8a8e48e..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,10 +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;
@@ -48,24 +52,33 @@ public final class CodeHelpers {
}
/**
- * Require an argument being received. This is similar to {@link java.util.Objects#requireNonNull(Object)}, but
- * throws an IllegalArgumentException.
+ * Return value and check whether specified value is null and if so throws exception. This method supports
+ * require default getter methods.
*
- *
- * Implementation note: we expect argName to be a string literal or a constant, so that it's non-nullness can be
- * quickly discovered for a call site (where we are going to be inlined).
+ * @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 Symbolic name
- * @return non-null value
- * @throws IllegalArgumentException if value is null
- * @throws NullPointerException if name is null
+ * @param name Name of the value
+ * @return Non-null value
+ * @throws NullPointerException if value is null
*/
- // FIXME: another advantage is that it is JDT-annotated, but we could live without that. At some point we should
- // schedule a big ISE-to-NPE conversion and just use Objects.requireNonNull() instead.
- public static @NonNull T nonNullValue(@Nullable final T value, final @NonNull String name) {
- requireNonNull(name);
- checkArgument(value != null, "%s must not be null", name);
+ 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;
}
@@ -75,7 +88,7 @@ public final class CodeHelpers {
* @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");
}
@@ -104,10 +117,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.
@@ -183,6 +214,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));
}
@@ -269,6 +301,31 @@ public final class CodeHelpers {
return input != null ? input : ImmutableMap.of();
}
+ /**
+ * Check whether specified List is empty and if so return null, otherwise return input list. This method supports
+ * Builder/implementation list handover.
+ *
+ * @param list element type
+ * @param input input list, may be null
+ * @return Input list or null.
+ */
+ public static @Nullable List emptyToNull(final @Nullable List input) {
+ return input != null && input.isEmpty() ? null : input;
+ }
+
+ /**
+ * Check whether specified Map is empty and if so return null, otherwise return input map. This method supports
+ * Builder/implementation list handover.
+ *
+ * @param key type
+ * @param value type
+ * @param input input map, may be null
+ * @return Input map or null.
+ */
+ public static @Nullable Map emptyToNull(final @Nullable Map input) {
+ return input != null && input.isEmpty() ? null : input;
+ }
+
/**
* 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}
@@ -293,13 +350,169 @@ public final class CodeHelpers {
return wrapHashCode(Arrays.hashCode(obj));
}
+ /**
+ * 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 @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 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 @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);
+ }
+ }
+
+ /**
+ * 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 @Nullable Class extends T> checkFieldCastIdentity(
+ final @NonNull Class 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
+ * @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 @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 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 @Nullable List> checkListFieldCastIdentity(
+ final @NonNull Class requiredClass, final @NonNull String fieldName, final @Nullable List> list) {
+ checkCollectionFieldIdentity(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;
+ }
+
+ /**
+ * 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 @Nullable Set> checkSetFieldCastIdentity(
+ final @NonNull Class requiredClass, final @NonNull String fieldName, final @Nullable Set> set) {
+ checkCollectionFieldIdentity(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);
+ }
+ }
+ }
+
+ @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);
+ }
+ }
+ }
+
/**
* 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.
*