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.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
* to perform specific shared functions. This allows for generated classes to be leaner. Methods in this class follows
* general API stability requirements of the Binding Specification.
- *
- * @author Robert Varga
*/
public final class CodeHelpers {
private CodeHelpers() {
checkArgument(expression, "expected one of: %s \n%but was: %s", options, value);
}
+ /**
+ * Return value and check whether specified value is {@code 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 {@code 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)}.
+ *
+ * @param value Value itself
+ * @param name Name of the value
+ * @return Non-null value
+ * @throws NullPointerException if value is {@code 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
+ * @throws NullPointerException if value is {@code 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");
}
/**
- * Append a named value to a ToStringHelper. If the value is null, this method does nothing.
+ * Append a {@code bits} individual value. If the value is {@code false}, this method does nothing.
+ *
+ * @param helper Helper to append to
+ * @param name Name of the bit
+ * @param value Value to append
+ * @throws NullPointerException if any argument is {@code null}
+ */
+ public static void appendBit(final ToStringHelper helper, final @NonNull String name, final boolean value) {
+ if (value) {
+ helper.addValue(name);
+ }
+ }
+
+ /**
+ * Append a named value to a ToStringHelper. If the value is {@code null}, this method does nothing.
*
* @param helper Helper to append to
* @param name Name of the value
* @param value Value to append
- * @throws NullPointerException if the name or helper is null
+ * @throws NullPointerException if the name or helper is {@code null}
*/
public static void appendValue(final ToStringHelper helper, final @NonNull String name,
final @Nullable Object value) {
}
/**
- * Append a named value to a ToStringHelper. If the value is null, this method does nothing.
+ * Append a named value to a ToStringHelper. If the value is {@code null}, this method does nothing.
*
* @param helper Helper to append to
* @param name Name of the value
* @param value Value to append
- * @throws NullPointerException if the name or helper is null
+ * @throws NullPointerException if the name or helper is {@code null}
*/
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 {@code null} or empty, 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 {@code 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());
}
}
*
* @param patterns Patterns to compile
* @return Compiled patterns in an array
- * @throws NullPointerException if the list or any of its elements is null
+ * @throws NullPointerException if the list or any of its elements is {@code null}
* @throws VerifyException if the list has fewer than two elements
*/
public static Pattern @NonNull[] compilePatterns(final @NonNull List<String> patterns) {
* @param pattern Enforcement pattern
* @param regex Source regular expression, as defined in YANG model
* @throws IllegalArgumentException if the value does not match the pattern
- * @throws NullPointerException if any of the arguments are null
+ * @throws NullPointerException if any of the arguments is {@code null}
*/
public static void checkPattern(final String value, final Pattern pattern, final String regex) {
if (!pattern.matcher(value).matches()) {
* @param patterns Enforcement patterns
* @param regexes Source regular expression, as defined in YANG model. Size and order must match patterns.
* @throws IllegalArgumentException if the value does not match the pattern
- * @throws NullPointerException if any of the arguments are null
+ * @throws NullPointerException if any of the arguments is {@code null}
* @throws VerifyException if the size of patterns and regexes does not match
*/
public static void checkPattern(final String value, final Pattern[] patterns, final String[] regexes) {
* @throws IllegalArgumentException always
*/
public static void throwInvalidLength(final String expected, final byte[] actual) {
- throwInvalidLength(expected, Arrays.toString(actual));
+ throwInvalidLength(expected, HexFormat.of().formatHex(actual));
}
/**
}
/**
- * Check whether specified List is null and if so return an immutable list instead. This method supports
+ * Check whether specified List is {@code null} and if so return an immutable list instead. This method supports
* non-null default getter methods.
*
* @param <T> list element type
- * @param input input list, may be null
+ * @param input input list, may be {@code null}
* @return Input list or an empty list.
*/
public static <T> @NonNull List<T> nonnull(final @Nullable List<T> input) {
}
/**
- * Check whether specified Map is null and if so return an immutable map instead. This method supports
+ * Check whether specified Map is {@code null} and if so return an immutable map instead. This method supports
* non-null default getter methods.
*
* @param <K> key type
* @param <V> value type
- * @param input input map, may be null
+ * @param input input map, may be {@code null}
* @return Input map or an empty map.
*/
public static <K, V> @NonNull Map<K, V> nonnull(final @Nullable Map<K, V> input) {
}
/**
- * Check whether specified List is empty and if so return null, otherwise return input list. This method supports
- * Builder/implementation list handover.
+ * Check whether specified List is empty and if so return {@code null}, otherwise return input list. This method
+ * supports Builder/implementation list handover.
*
* @param <T> list element type
- * @param input input list, may be null
- * @return Input list or null.
+ * @param input input list, may be {@code null}
+ * @return Input list or {@code null}.
*/
public static <T> @Nullable List<T> emptyToNull(final @Nullable List<T> 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.
+ * Check whether specified Map is empty and if so return {@code null}, otherwise return input map. This method
+ * supports Builder/implementation list handover.
*
* @param <K> key type
* @param <V> value type
- * @param input input map, may be null
- * @return Input map or null.
+ * @param input input map, may be {@code null}
+ * @return Input map or {@code null}.
*/
public static <K, V> @Nullable Map<K, V> emptyToNull(final @Nullable Map<K, V> input) {
return input != null && input.isEmpty() ? null : input;
}
/**
- * Compatibility utility for turning a List of identifiable objects to an indexed map.
- *
- * @param <K> key type
- * @param <V> 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 <K extends Identifier<V>, V extends Identifiable<K>> @Nullable Map<K, V> compatMap(
- final @Nullable List<V> 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}
- * for both non-present and present-with-null objects.
+ * Return hash code of a single-property wrapper class. Since the wrapper is not {@code 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} for both non-present and present-with-null objects.
*
* @param obj Internal object to hash
* @return Wrapper object hash code
}
/**
- * 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 Arrays#hashCode()} is not really useful we would end up with {@code 0}
- * for both non-present and present-with-null objects.
+ * Return hash code of a single-property wrapper class. Since the wrapper is not {@code null}, we really want to
+ * discern this object being present, hence {@link Arrays#hashCode()} is not really useful we would end up with
+ * {@code 0} for both non-present and present-with-null objects.
*
* @param obj Internal object to hash
* @return Wrapper object hash code
}
/**
- * 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:
+ * <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 {@code null} or its hashCode being 0.
+ *
+ * @param hash Wrapped object hash
+ * @return Wrapper object hash
+ */
+ private static int wrapHashCode(final int hash) {
+ return hash == 0 ? 31 : hash;
+ }
+
+ /**
+ * Check that the specified {@link EnumTypeObject} 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 Uint8
- * @deprecated This method is provided for migration purposes only, do not use it outside of deprecated
- * compatibility methods.
+ * @param obj enumeration object, possibly {@code null}
+ * @param name User-supplied enumeration name
+ * @return Enumeration object
+ * @throws IllegalArgumentException if {@code obj} is {@code null}
*/
- @Deprecated
- public static @Nullable Uint8 compatUint(final @Nullable Short value) {
- return value == null ? null : Uint8.valueOf(value.shortValue());
+ public static <T extends EnumTypeObject> @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 Integer} {@code uint16} value to its {@link Uint16}
- * counterpart.
+ * Check that the specified {@link EnumTypeObject} 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 {@code null}
+ * @param value User-supplied enumeration value
+ * @return Enumeration object
+ * @throws IllegalArgumentException if {@code obj} is {@code null}
*/
- @Deprecated
- public static @Nullable Uint16 compatUint(final @Nullable Integer value) {
- return value == null ? null : Uint16.valueOf(value.intValue());
+ public static <T extends EnumTypeObject> @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 Long} {@code uint32} value to its {@link Uint32}
- * counterpart.
+ * Utility method for checking whether a target object is a compatible {@link BindingContract}.
*
- * @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 requiredClass Required BindingContract class
+ * @param obj Object to check, may be {@code null}
+ * @return Object cast to required class, if its implemented class matches requirement, {@code null} otherwise
+ * @throws NullPointerException if {@code requiredClass} is {@code null}
*/
- @Deprecated
- public static @Nullable Uint32 compatUint(final @Nullable Long value) {
- return value == null ? null : Uint32.valueOf(value.longValue());
+ public static <T extends BindingContract<?>> @Nullable T checkCast(final @NonNull Class<T> requiredClass,
+ final @Nullable Object obj) {
+ return obj instanceof BindingContract<?> contract && requiredClass.equals(contract.implementedInterface())
+ ? requiredClass.cast(obj) : null;
}
/**
- * 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 compatible.
*
- * @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 class
+ * @param fieldName name of the field being filled
+ * @param obj Object to check, may be {@code null}
+ * @return Object cast to required class, if its class matches requirement, or {@code null}
+ * @throws IllegalArgumentException if {@code obj} is not an instance of {@code requiredClass}
+ * @throws NullPointerException if {@code requiredClass} or {@code fieldName} is {@code null}
*/
- @Deprecated
- public static @Nullable Uint64 compatUint(final @Nullable BigInteger value) {
- return value == null ? null : Uint64.valueOf(value);
+ 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 for extracting augmentations from an implementation of {@link AugmentationHolder} interface.
+ * Utility method for checking whether the items of target list is compatible.
*
- * @param obj Implementation object
- * @return hash code of augmentations
- * @throws NullPointerException if obj is null
+ * @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 {@code null}
*/
- public static int hashAugmentations(final @NonNull AugmentationHolder<?> obj) {
- return Objects.hashCode(obj.augmentations());
+ @SuppressWarnings("unchecked")
+ public static <T> @Nullable List<T> checkListFieldCast(final @NonNull Class<T> requiredClass,
+ final @NonNull String fieldName, final @Nullable List<?> list) {
+ DoNotLeakSpotbugs.checkCollectionField(requiredClass, fieldName, list);
+ return (List<T>) list;
}
/**
- * The constant '31' is the result of folding this code:
- * <pre>
- * final int prime = 31;
- * int result = 1;
- * result = result * prime + Objects.hashCode(obj);
- * return result;
- * </pre>
- * 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 set 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 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 {@code null}
*/
- private static int wrapHashCode(final int hash) {
- return hash == 0 ? 31 : hash;
+ @SuppressWarnings("unchecked")
+ public static <T> @Nullable Set<T> checkSetFieldCast(final @NonNull Class<T> requiredClass,
+ final @NonNull String fieldName, final @Nullable Set<?> set) {
+ DoNotLeakSpotbugs.checkCollectionField(requiredClass, fieldName, set);
+ return (Set<T>) set;
}
}
Code Review / mdsal.git / blobdiff