> E caseInsensitiveValueOf(E[] enumValues, String constant) {
for (final E candidate : enumValues) {
if (candidate.toString().equalsIgnoreCase(constant)) {
return candidate;
}
}
throw new IllegalArgumentException(String.format("constant [%s] does not exist in enum type %s", constant,
enumValues.getClass().getComponentType().getName()));
}
/**
* Check whether the given array of enum constants contains a constant with the given name, ignoring case when determining a match.
*
* @param enumValues
* the enum values to check, typically the product of a call to MyEnum.values()
* @param constant
* the constant name to find (must not be null or empty string)
* @return whether the constant has been found in the given array
*/
public static boolean containsConstant(Enum[] enumValues, String constant) {
return ObjectUtils.containsConstant(enumValues, constant, false);
}
/**
* Check whether the given array of enum constants contains a constant with the given name.
*
* @param enumValues
* the enum values to check, typically the product of a call to MyEnum.values()
* @param constant
* the constant name to find (must not be null or empty string)
* @param caseSensitive
* whether case is significant in determining a match
* @return whether the constant has been found in the given array
*/
public static boolean containsConstant(Enum[] enumValues, String constant, boolean caseSensitive) {
for (final Enum candidate : enumValues) {
if (caseSensitive ? candidate.toString().equals(constant) : candidate.toString().equalsIgnoreCase(constant)) {
return true;
}
}
return false;
}
/**
* Check whether the given array contains the given element.
*
* @param array
* the array to check (may be null, in which case the return value will always be false)
* @param element
* the element to check for
* @return whether the element has been found in the given array
*/
public static boolean containsElement(Object[] array, Object element) {
if (array == null) {
return false;
}
for (final Object arrayEle : array) {
if (ObjectUtils.nullSafeEquals(arrayEle, element)) {
return true;
}
}
return false;
}
/**
* Return a content-based String representation if obj is not null; otherwise returns an empty String.
*
* Differs from {@link #nullSafeToString(Object)} in that it returns an empty String rather than "null" for a null value.
*
* @param obj
* the object to build a display String for
* @return a display String representation of obj
* @see #nullSafeToString(Object)
*/
public static String getDisplayString(Object obj) {
if (obj == null) {
return ObjectUtils.EMPTY_STRING;
}
return ObjectUtils.nullSafeToString(obj);
}
/**
* Return a hex String form of an object's identity hash code.
*
* @param obj
* the object
* @return the object's identity code in hex notation
*/
public static String getIdentityHexString(Object obj) {
return Integer.toHexString(System.identityHashCode(obj));
}
/**
* Return the same value as {@link Boolean#hashCode()}.
*
* @param bool
* the boolean value
* @return the hash code
*
* @see Boolean#hashCode()
*/
public static int hashCode(boolean bool) {
return bool ? 1231 : 1237;
}
/**
* Return the same value as {@link Double#hashCode()}.
*
* @param dbl
* the double value
* @return the hash code
*
* @see Double#hashCode()
*/
public static int hashCode(double dbl) {
final long bits = Double.doubleToLongBits(dbl);
return ObjectUtils.hashCode(bits);
}
/**
* Return the same value as {@link Float#hashCode()}.
*
* @param flt
* the float value
* @return the hash code
*
* @see Float#hashCode()
*/
public static int hashCode(float flt) {
return Float.floatToIntBits(flt);
}
/**
* Return the same value as {@link Long#hashCode()}.
*
* @param lng
* the long value
* @return the hash code
*
* @see Long#hashCode()
*/
public static int hashCode(long lng) {
return (int) (lng ^ (lng >>> 32));
}
/**
* Return a String representation of an object's overall identity.
*
* @param obj
* the object (may be null)
* @return the object's identity as String representation, or an empty String if the object was null
*/
public static String identityToString(Object obj) {
if (obj == null) {
return ObjectUtils.EMPTY_STRING;
}
return obj.getClass().getName() + "@" + ObjectUtils.getIdentityHexString(obj);
}
/**
* Determine whether the given object is an array: either an Object array or a primitive array.
*
* @param obj
* the object to check
* @return true of object is an array false otherwise
*/
public static boolean isArray(Object obj) {
return ((obj != null) && obj.getClass().isArray());
}
/**
* Return whether the given throwable is a checked exception: that is, neither a RuntimeException nor an Error.
*
* @param ex
* the throwable to check
* @return whether the throwable is a checked exception
* @see java.lang.Exception
* @see java.lang.RuntimeException
* @see java.lang.Error
*/
public static boolean isCheckedException(Throwable ex) {
return !((ex instanceof RuntimeException) || (ex instanceof Error));
}
/**
* Check whether the given exception is compatible with the exceptions declared in a throws clause.
*
* @param ex
* the exception to checked
* @param declaredExceptions
* the exceptions declared in the throws clause
* @return whether the given exception is compatible
*/
public static boolean isCompatibleWithThrowsClause(Throwable ex, Class[] declaredExceptions) {
if (!ObjectUtils.isCheckedException(ex)) {
return true;
}
if (declaredExceptions != null) {
int i = 0;
while (i < declaredExceptions.length) {
if (declaredExceptions[i].isAssignableFrom(ex.getClass())) {
return true;
}
i++;
}
}
return false;
}
/**
* Determine whether the given array is empty: i.e. null or of zero length.
*
* @param array
* the array to check
* @return true if the array is empty, false otherwise
*/
public static boolean isEmpty(Object[] array) {
return ((array == null) || (array.length == 0));
}
/**
* Determine the class name for the given object.
*
* Returns "null" if obj is null.
*
* @param obj
* the object to introspect (may be null)
* @return the corresponding class name
*/
public static String nullSafeClassName(Object obj) {
return (obj != null ? obj.getClass().getName() : ObjectUtils.NULL_STRING);
}
/**
* Determine if the given objects are equal, returning true if both are null or false if only one
* is null.
*
* Compares arrays with Arrays.equals, performing an equality check based on the array elements rather than the array
* reference.
*
* @param o1
* first Object to compare
* @param o2
* second Object to compare
* @return whether the given objects are equal
* @see java.util.Arrays#equals
*/
public static boolean nullSafeEquals(Object o1, Object o2) {
if (o1 == o2) {
return true;
}
if ((o1 == null) || (o2 == null)) {
return false;
}
if (o1.equals(o2)) {
return true;
}
if (o1.getClass().isArray() && o2.getClass().isArray()) {
if ((o1 instanceof Object[]) && (o2 instanceof Object[])) {
return Arrays.equals((Object[]) o1, (Object[]) o2);
}
if ((o1 instanceof boolean[]) && (o2 instanceof boolean[])) {
return Arrays.equals((boolean[]) o1, (boolean[]) o2);
}
if ((o1 instanceof byte[]) && (o2 instanceof byte[])) {
return Arrays.equals((byte[]) o1, (byte[]) o2);
}
if ((o1 instanceof char[]) && (o2 instanceof char[])) {
return Arrays.equals((char[]) o1, (char[]) o2);
}
if ((o1 instanceof double[]) && (o2 instanceof double[])) {
return Arrays.equals((double[]) o1, (double[]) o2);
}
if ((o1 instanceof float[]) && (o2 instanceof float[])) {
return Arrays.equals((float[]) o1, (float[]) o2);
}
if ((o1 instanceof int[]) && (o2 instanceof int[])) {
return Arrays.equals((int[]) o1, (int[]) o2);
}
if ((o1 instanceof long[]) && (o2 instanceof long[])) {
return Arrays.equals((long[]) o1, (long[]) o2);
}
if ((o1 instanceof short[]) && (o2 instanceof short[])) {
return Arrays.equals((short[]) o1, (short[]) o2);
}
}
return false;
}
/**
* Return a hash code based on the contents of the specified array. If array is null, this method returns 0.
*
* @param array
* the array value
* @return the hash code
*/
public static int nullSafeHashCode(boolean[] array) {
if (array == null) {
return 0;
}
int hash = ObjectUtils.INITIAL_HASH;
final int arraySize = array.length;
for (int i = 0; i < arraySize; i++) {
hash = (ObjectUtils.MULTIPLIER * hash) + ObjectUtils.hashCode(array[i]);
}
return hash;
}
/**
* Return a hash code based on the contents of the specified array. If array is null, this method returns 0.
*
* @param array
* the array value
* @return the hash code
*/
public static int nullSafeHashCode(byte[] array) {
if (array == null) {
return 0;
}
int hash = ObjectUtils.INITIAL_HASH;
final int arraySize = array.length;
for (int i = 0; i < arraySize; i++) {
hash = (ObjectUtils.MULTIPLIER * hash) + array[i];
}
return hash;
}
/**
* Return a hash code based on the contents of the specified array. If array is null, this method returns 0.
*
* @param array
* the array value
* @return the hash code
*/
public static int nullSafeHashCode(char[] array) {
if (array == null) {
return 0;
}
int hash = ObjectUtils.INITIAL_HASH;
final int arraySize = array.length;
for (int i = 0; i < arraySize; i++) {
hash = (ObjectUtils.MULTIPLIER * hash) + array[i];
}
return hash;
}
/**
* Return a hash code based on the contents of the specified array. If array is null, this method returns 0.
*
* @param array
* the array value
* @return the hash code
*/
public static int nullSafeHashCode(double[] array) {
if (array == null) {
return 0;
}
int hash = ObjectUtils.INITIAL_HASH;
final int arraySize = array.length;
for (int i = 0; i < arraySize; i++) {
hash = (ObjectUtils.MULTIPLIER * hash) + ObjectUtils.hashCode(array[i]);
}
return hash;
}
/**
* Return a hash code based on the contents of the specified array. If array is null, this method returns 0.
*
* @param array
* the array value
* @return the hash code
*/
public static int nullSafeHashCode(float[] array) {
if (array == null) {
return 0;
}
int hash = ObjectUtils.INITIAL_HASH;
final int arraySize = array.length;
for (int i = 0; i < arraySize; i++) {
hash = (ObjectUtils.MULTIPLIER * hash) + ObjectUtils.hashCode(array[i]);
}
return hash;
}
/**
* Return a hash code based on the contents of the specified array. If array is null, this method returns 0.
*
* @param array
* the array value
* @return the hash code
*/
public static int nullSafeHashCode(int[] array) {
if (array == null) {
return 0;
}
int hash = ObjectUtils.INITIAL_HASH;
final int arraySize = array.length;
for (int i = 0; i < arraySize; i++) {
hash = (ObjectUtils.MULTIPLIER * hash) + array[i];
}
return hash;
}
/**
* Return a hash code based on the contents of the specified array. If array is null, this method returns 0.
*
* @param array
* the array value
* @return the hash code
*/
public static int nullSafeHashCode(long[] array) {
if (array == null) {
return 0;
}
int hash = ObjectUtils.INITIAL_HASH;
final int arraySize = array.length;
for (int i = 0; i < arraySize; i++) {
hash = (ObjectUtils.MULTIPLIER * hash) + ObjectUtils.hashCode(array[i]);
}
return hash;
}
/**
* Return as hash code for the given object; typically the value of {@link Object#hashCode()}. If the object is an array,
* this method will delegate to any of the nullSafeHashCode methods for arrays in this class. If the object is
* null, this method returns 0.
*
* @param obj
* the object value
* @return the hash code
*
* @see #nullSafeHashCode(Object[])
* @see #nullSafeHashCode(boolean[])
* @see #nullSafeHashCode(byte[])
* @see #nullSafeHashCode(char[])
* @see #nullSafeHashCode(double[])
* @see #nullSafeHashCode(float[])
* @see #nullSafeHashCode(int[])
* @see #nullSafeHashCode(long[])
* @see #nullSafeHashCode(short[])
*/
public static int nullSafeHashCode(Object obj) {
if (obj == null) {
return 0;
}
if (obj.getClass().isArray()) {
if (obj instanceof Object[]) {
return ObjectUtils.nullSafeHashCode((Object[]) obj);
}
if (obj instanceof boolean[]) {
return ObjectUtils.nullSafeHashCode((boolean[]) obj);
}
if (obj instanceof byte[]) {
return ObjectUtils.nullSafeHashCode((byte[]) obj);
}
if (obj instanceof char[]) {
return ObjectUtils.nullSafeHashCode((char[]) obj);
}
if (obj instanceof double[]) {
return ObjectUtils.nullSafeHashCode((double[]) obj);
}
if (obj instanceof float[]) {
return ObjectUtils.nullSafeHashCode((float[]) obj);
}
if (obj instanceof int[]) {
return ObjectUtils.nullSafeHashCode((int[]) obj);
}
if (obj instanceof long[]) {
return ObjectUtils.nullSafeHashCode((long[]) obj);
}
if (obj instanceof short[]) {
return ObjectUtils.nullSafeHashCode((short[]) obj);
}
}
return obj.hashCode();
}
/**
* Return a hash code based on the contents of the specified array. If array is null, this method returns 0.
*
* @param array
* the array value
* @return the hash code
*/
public static int nullSafeHashCode(Object[] array) {
if (array == null) {
return 0;
}
int hash = ObjectUtils.INITIAL_HASH;
final int arraySize = array.length;
for (int i = 0; i < arraySize; i++) {
hash = (ObjectUtils.MULTIPLIER * hash) + ObjectUtils.nullSafeHashCode(array[i]);
}
return hash;
}
/**
* Return a hash code based on the contents of the specified array. If array is null, this method returns 0.
*
* @param array
* the array value
* @return the hash code
*/
public static int nullSafeHashCode(short[] array) {
if (array == null) {
return 0;
}
int hash = ObjectUtils.INITIAL_HASH;
final int arraySize = array.length;
for (int i = 0; i < arraySize; i++) {
hash = (ObjectUtils.MULTIPLIER * hash) + array[i];
}
return hash;
}
/**
* Return a String representation of the contents of the specified array.
*
* The String representation consists of a list of the array's elements, enclosed in curly braces ("{}"). Adjacent elements
* are separated by the characters ", " (a comma followed by a space). Returns "null" if array is
* null.
*
* @param array
* the array to build a String representation for
* @return a String representation of array
*/
public static String nullSafeToString(boolean[] array) {
if (array == null) {
return ObjectUtils.NULL_STRING;
}
final int length = array.length;
if (length == 0) {
return ObjectUtils.EMPTY_ARRAY;
}
final StringBuilder sb = new StringBuilder();
for (int i = 0; i < length; i++) {
if (i == 0) {
sb.append(ObjectUtils.ARRAY_START);
}
else {
sb.append(ObjectUtils.ARRAY_ELEMENT_SEPARATOR);
}
sb.append(array[i]);
}
sb.append(ObjectUtils.ARRAY_END);
return sb.toString();
}
/**
* Return a String representation of the contents of the specified array.
*
* The String representation consists of a list of the array's elements, enclosed in curly braces ("{}"). Adjacent elements
* are separated by the characters ", " (a comma followed by a space). Returns "null" if array is
* null.
*
* @param array
* the array to build a String representation for
* @return a String representation of array
*/
public static String nullSafeToString(byte[] array) {
if (array == null) {
return ObjectUtils.NULL_STRING;
}
final int length = array.length;
if (length == 0) {
return ObjectUtils.EMPTY_ARRAY;
}
final StringBuilder sb = new StringBuilder();
for (int i = 0; i < length; i++) {
if (i == 0) {
sb.append(ObjectUtils.ARRAY_START);
}
else {
sb.append(ObjectUtils.ARRAY_ELEMENT_SEPARATOR);
}
sb.append(array[i]);
}
sb.append(ObjectUtils.ARRAY_END);
return sb.toString();
}
/**
* Return a String representation of the contents of the specified array.
*
* The String representation consists of a list of the array's elements, enclosed in curly braces ("{}"). Adjacent elements
* are separated by the characters ", " (a comma followed by a space). Returns "null" if array is
* null.
*
* @param array
* the array to build a String representation for
* @return a String representation of array
*/
public static String nullSafeToString(char[] array) {
if (array == null) {
return ObjectUtils.NULL_STRING;
}
final int length = array.length;
if (length == 0) {
return ObjectUtils.EMPTY_ARRAY;
}
final StringBuilder sb = new StringBuilder();
for (int i = 0; i < length; i++) {
if (i == 0) {
sb.append(ObjectUtils.ARRAY_START);
}
else {
sb.append(ObjectUtils.ARRAY_ELEMENT_SEPARATOR);
}
sb.append("'").append(array[i]).append("'");
}
sb.append(ObjectUtils.ARRAY_END);
return sb.toString();
}
/**
* Return a String representation of the contents of the specified array.
*
* The String representation consists of a list of the array's elements, enclosed in curly braces ("{}"). Adjacent elements
* are separated by the characters ", " (a comma followed by a space). Returns "null" if array is
* null.
*
* @param array
* the array to build a String representation for
* @return a String representation of array
*/
public static String nullSafeToString(double[] array) {
if (array == null) {
return ObjectUtils.NULL_STRING;
}
final int length = array.length;
if (length == 0) {
return ObjectUtils.EMPTY_ARRAY;
}
final StringBuilder sb = new StringBuilder();
for (int i = 0; i < length; i++) {
if (i == 0) {
sb.append(ObjectUtils.ARRAY_START);
}
else {
sb.append(ObjectUtils.ARRAY_ELEMENT_SEPARATOR);
}
sb.append(array[i]);
}
sb.append(ObjectUtils.ARRAY_END);
return sb.toString();
}
/**
* Return a String representation of the contents of the specified array.
*
* The String representation consists of a list of the array's elements, enclosed in curly braces ("{}"). Adjacent elements
* are separated by the characters ", " (a comma followed by a space). Returns "null" if array is
* null.
*
* @param array
* the array to build a String representation for
* @return a String representation of array
*/
public static String nullSafeToString(float[] array) {
if (array == null) {
return ObjectUtils.NULL_STRING;
}
final int length = array.length;
if (length == 0) {
return ObjectUtils.EMPTY_ARRAY;
}
final StringBuilder sb = new StringBuilder();
for (int i = 0; i < length; i++) {
if (i == 0) {
sb.append(ObjectUtils.ARRAY_START);
}
else {
sb.append(ObjectUtils.ARRAY_ELEMENT_SEPARATOR);
}
sb.append(array[i]);
}
sb.append(ObjectUtils.ARRAY_END);
return sb.toString();
}
/**
* Return a String representation of the contents of the specified array.
*
* The String representation consists of a list of the array's elements, enclosed in curly braces ("{}"). Adjacent elements
* are separated by the characters ", " (a comma followed by a space). Returns "null" if array is
* null.
*
* @param array
* the array to build a String representation for
* @return a String representation of array
*/
public static String nullSafeToString(int[] array) {
if (array == null) {
return ObjectUtils.NULL_STRING;
}
final int length = array.length;
if (length == 0) {
return ObjectUtils.EMPTY_ARRAY;
}
final StringBuilder sb = new StringBuilder();
for (int i = 0; i < length; i++) {
if (i == 0) {
sb.append(ObjectUtils.ARRAY_START);
}
else {
sb.append(ObjectUtils.ARRAY_ELEMENT_SEPARATOR);
}
sb.append(array[i]);
}
sb.append(ObjectUtils.ARRAY_END);
return sb.toString();
}
/**
* Return a String representation of the contents of the specified array.
*
* The String representation consists of a list of the array's elements, enclosed in curly braces ("{}"). Adjacent elements
* are separated by the characters ", " (a comma followed by a space). Returns "null" if array is
* null.
*
* @param array
* the array to build a String representation for
* @return a String representation of array
*/
public static String nullSafeToString(long[] array) {
if (array == null) {
return ObjectUtils.NULL_STRING;
}
final int length = array.length;
if (length == 0) {
return ObjectUtils.EMPTY_ARRAY;
}
final StringBuilder sb = new StringBuilder();
for (int i = 0; i < length; i++) {
if (i == 0) {
sb.append(ObjectUtils.ARRAY_START);
}
else {
sb.append(ObjectUtils.ARRAY_ELEMENT_SEPARATOR);
}
sb.append(array[i]);
}
sb.append(ObjectUtils.ARRAY_END);
return sb.toString();
}
/**
* Return a String representation of the specified Object.
*
* Builds a String representation of the contents in case of an array. Returns "null" if obj is
* null.
*
* @param obj
* the object to build a String representation for
* @return a String representation of obj
*/
public static String nullSafeToString(Object obj) {
if (obj == null) {
return ObjectUtils.NULL_STRING;
}
if (obj instanceof String) {
return (String) obj;
}
if (obj instanceof Object[]) {
return ObjectUtils.nullSafeToString((Object[]) obj);
}
if (obj instanceof boolean[]) {
return ObjectUtils.nullSafeToString((boolean[]) obj);
}
if (obj instanceof byte[]) {
return ObjectUtils.nullSafeToString((byte[]) obj);
}
if (obj instanceof char[]) {
return ObjectUtils.nullSafeToString((char[]) obj);
}
if (obj instanceof double[]) {
return ObjectUtils.nullSafeToString((double[]) obj);
}
if (obj instanceof float[]) {
return ObjectUtils.nullSafeToString((float[]) obj);
}
if (obj instanceof int[]) {
return ObjectUtils.nullSafeToString((int[]) obj);
}
if (obj instanceof long[]) {
return ObjectUtils.nullSafeToString((long[]) obj);
}
if (obj instanceof short[]) {
return ObjectUtils.nullSafeToString((short[]) obj);
}
final String str = obj.toString();
return (str != null ? str : ObjectUtils.EMPTY_STRING);
}
/**
* Return a String representation of the contents of the specified array.
*
* The String representation consists of a list of the array's elements, enclosed in curly braces ("{}"). Adjacent elements
* are separated by the characters ", " (a comma followed by a space). Returns "null" if array is
* null.
*
* @param array
* the array to build a String representation for
* @return a String representation of array
*/
public static String nullSafeToString(Object[] array) {
if (array == null) {
return ObjectUtils.NULL_STRING;
}
final int length = array.length;
if (length == 0) {
return ObjectUtils.EMPTY_ARRAY;
}
final StringBuilder sb = new StringBuilder();
for (int i = 0; i < length; i++) {
if (i == 0) {
sb.append(ObjectUtils.ARRAY_START);
}
else {
sb.append(ObjectUtils.ARRAY_ELEMENT_SEPARATOR);
}
sb.append(String.valueOf(array[i]));
}
sb.append(ObjectUtils.ARRAY_END);
return sb.toString();
}
/**
* Return a String representation of the contents of the specified array.
*
* The String representation consists of a list of the array's elements, enclosed in curly braces ("{}"). Adjacent elements
* are separated by the characters ", " (a comma followed by a space). Returns "null" if array is
* null.
*
* @param array
* the array to build a String representation for
* @return a String representation of array
*/
public static String nullSafeToString(short[] array) {
if (array == null) {
return ObjectUtils.NULL_STRING;
}
final int length = array.length;
if (length == 0) {
return ObjectUtils.EMPTY_ARRAY;
}
final StringBuilder sb = new StringBuilder();
for (int i = 0; i < length; i++) {
if (i == 0) {
sb.append(ObjectUtils.ARRAY_START);
}
else {
sb.append(ObjectUtils.ARRAY_ELEMENT_SEPARATOR);
}
sb.append(array[i]);
}
sb.append(ObjectUtils.ARRAY_END);
return sb.toString();
}
/**
* Convert the given array (which may be a primitive array) to an object array (if necessary of primitive wrapper objects).
*
* A null source value will be converted to an empty Object array.
*
* @param source
* the (potentially primitive) array
* @return the corresponding object array (never null)
* @throws IllegalArgumentException
* if the parameter is not an array
*/
public static Object[] toObjectArray(Object source) {
if (source instanceof Object[]) {
return (Object[]) source;
}
if (source == null) {
return new Object[0];
}
if (!source.getClass().isArray()) {
throw new IllegalArgumentException("Source is not an array: " + source);
}
final int length = Array.getLength(source);
if (length == 0) {
return new Object[0];
}
final Class wrapperType = Array.get(source, 0).getClass();
final Object[] newArray = (Object[]) Array.newInstance(wrapperType, length);
for (int i = 0; i < length; i++) {
newArray[i] = Array.get(source, i);
}
return newArray;
}
}
