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 java.util.Arrays;
import java.util.List;
+import java.util.Map;
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
}
/**
- * Require an argument being received. This is similar to {@link java.util.Objects#requireNonNull(Object)}, but
- * throws an IllegalArgumentException.
- *
- * <p>
- * 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).
+ * 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 <T> @NonNull T nonNullValue(@Nullable final T value, final @NonNull String name) {
- requireNonNull(name);
- checkArgument(value != null, "%s must not be null", name);
+ 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(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.
*
* @param value Value to append
* @throws NullPointerException if the name or helper is null
*/
- public static void appendValue(final @NonNull ToStringHelper helper, final @NonNull String name,
+ public static void appendValue(final ToStringHelper helper, final @NonNull String name,
final @Nullable Object value) {
if (value != null) {
helper.add(name, value);
* @throws NullPointerException if the list or any of its elements is null
* @throws VerifyException if the list has fewer than two elements
*/
- public static @NonNull Pattern[] compilePatterns(final @NonNull List<String> patterns) {
+ public static Pattern @NonNull[] compilePatterns(final @NonNull List<String> patterns) {
final int size = patterns.size();
verify(size > 1, "Patterns has to have at least 2 elements");
- final @NonNull Pattern[] result = new Pattern[size];
+ final Pattern[] result = new Pattern[size];
for (int i = 0; i < size; ++i) {
result[i] = Pattern.compile(patterns.get(i));
}
throwInvalidRange(Arrays.toString(expected), actual);
}
+ /**
+ * Throw an IllegalArgument exception describing a range violation of an Uint64 type.
+ *
+ * @param expected String describing expected ranges
+ * @param actual Actual observed value
+ * @throws IllegalArgumentException always
+ */
+ public static void throwInvalidRangeUnsigned(final String expected, final long actual) {
+ throw new IllegalArgumentException("Invalid range: " + Long.toUnsignedString(actual) + ", expected: " + expected
+ + ".");
+ }
+
/**
* Check whether specified List is 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
* @return Input list or an empty list.
*/
- public static <T> List<T> nonnull(final @Nullable List<T> input) {
+ public static <T> @NonNull List<T> nonnull(final @Nullable List<T> input) {
return input != null ? input : ImmutableList.of();
}
+ /**
+ * Check whether specified Map is 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
+ * @return Input map or an empty map.
+ */
+ public static <K, V> @NonNull Map<K, V> nonnull(final @Nullable Map<K, V> input) {
+ 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 <T> list element type
+ * @param input input list, may be null
+ * @return Input list or 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.
+ *
+ * @param <K> key type
+ * @param <V> value type
+ * @param input input map, may be null
+ * @return Input map or 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}
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>
Code Review / mdsal.git / blobdiff