import com.google.common.base.VerifyException;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
-import java.math.BigInteger;
+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;
-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
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 <T> @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)}.
*
*/
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.
* @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));
}
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.
*
}
}
+ /**
+ * 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;
}
/**
* The constant '31' is the result of folding this code:
* <pre>
+ * <code>
* final int prime = 31;
* int result = 1;
* result = result * prime + Objects.hashCode(obj);
* return result;
+ * </code>
* </pre>
* when hashCode is returned as 0, such as due to obj being null or its hashCode being 0.
*
Code Review / mdsal.git / blobdiff