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;
requireNonNull(value, "Supplied value may not be null");
}
+ /**
+ * 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 null, this method does nothing.
*
*/
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));
+ helper.add(name, HexFormat.of().formatHex(value));
}
}
* @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));
+ throwInvalidLength(expected, HexFormat.of().formatHex(actual));
}
/**
}
/**
- * Utility method for checking whether a target object is a compatible DataObject.
+ * 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.
+ *
+ * @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 requiredClass Required DataObject class
+ * @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 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;
+ }
+
+ /**
+ * 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 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 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;
+ }
+
+ /**
+ * Utility method for checking whether a target object is a compatible {@link BindingContract}.
+ *
+ * @param requiredClass Required BindingContract 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,
+ public static <T extends BindingContract<?>> @Nullable T checkCast(final @NonNull Class<T> requiredClass,
final @Nullable Object obj) {
- return obj instanceof DataObject && requiredClass.equals(((DataObject) obj).implementedInterface())
+ return obj instanceof BindingContract<?> contract && requiredClass.equals(contract.implementedInterface())
? requiredClass.cast(obj) : null;
}
* @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 requiredItemClass}
+ * @throws IllegalArgumentException if a list item is not instance of {@code requiredClass}
* @throws NullPointerException if {@code requiredClass} or {@code fieldName} is null
*/
@SuppressWarnings("unchecked")
}
/**
- * Utility method for checking whether the items of target list is compatible.
+ * 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
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 list item for property \"" + requireNonNull(fieldName)
+ throw new IllegalArgumentException("Invalid input item for property \"" + requireNonNull(fieldName)
+ "\"", e);
}
}
}
-
- /**
- * 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.
- *
- * @param hash Wrapped object hash
- * @return Wrapper object hash
- */
- private static int wrapHashCode(final int hash) {
- return hash == 0 ? 31 : hash;
- }
}
Code Review / mdsal.git / blobdiff