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.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;
}
/**
- * 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.
*
- * <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).
+ * @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)}.
*
* @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);
*/
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());
}
}
* @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));
}
* @throws IllegalArgumentException always
*/
public static void throwInvalidLength(final String expected, final byte[] actual) {
- throwInvalidLength(expected, Arrays.toString(actual));
+ throwInvalidLength(expected, HexFormat.of().formatHex(actual));
}
/**
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;
+ }
+
/**
* 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}
/**
* 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.
*
private static int wrapHashCode(final int hash) {
return hash == 0 ? 31 : hash;
}
+
+ /**
+ * 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 obj enumeration object, possibly null
+ * @param name User-supplied enumeration name
+ * @return Enumeration object
+ * @throws IllegalArgumentException if {@code obj} is null
+ */
+ public static <T extends Enumeration> @NonNull T checkEnum(final @Nullable T obj, final String name) {
+ if (obj == null) {
+ throw new IllegalArgumentException("\"" + name + "\" is not a valid name");
+ }
+ return obj;
+ }
+
+ /**
+ * 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 obj enumeration object, possibly null
+ * @param value User-supplied enumeration value
+ * @return Enumeration object
+ * @throws IllegalArgumentException if {@code obj} is null
+ */
+ public static <T extends Enumeration> @NonNull T checkEnum(final @Nullable T obj, final int value) {
+ if (obj == null) {
+ throw new IllegalArgumentException(value + " is not a valid value");
+ }
+ return 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 <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
+ * @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) {
+ checkCollectionField(requiredClass, fieldName, list);
+ return (List<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;
+ }
+
+ @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);
+ }
+ }
+ }
}
Code Review / mdsal.git / blobdiff