Objects (JJWT :: API 0.13.0 API)

java.lang.Object
- io.jsonwebtoken.lang.Objects

```
public final class Objects
extends Object
```
Utility methods for working with object instances to reduce pattern repetition and otherwise increased cyclomatic complexity.

Method Summary

Methods
Modifier and Type	Method and Description
`static <A,O extends A> A[]`	`addObjectToArray(A[] array, O obj)` Append the given object to the given array, returning a new array consisting of the input array contents plus the given object.
`static <E extends Enum<?>> E`	`caseInsensitiveValueOf(E[] enumValues, String constant)` Case insensitive alternative to `Enum.valueOf(Class, String)`.
`static boolean`	`containsConstant(Enum<?>[] enumValues, String constant)` Check whether the given array of enum constants contains a constant with the given name, ignoring case when determining a match.
`static boolean`	`containsConstant(Enum<?>[] enumValues, String constant, boolean caseSensitive)` Check whether the given array of enum constants contains a constant with the given name.
`static boolean`	`containsElement(Object[] array, Object element)` Check whether the given array contains the given element.
`static String`	`getDisplayString(Object obj)` Return a content-based String representation if `obj` is not `null`; otherwise returns an empty String.
`static String`	`getIdentityHexString(Object obj)` Return a hex String form of an object's identity hash code.
`static int`	`hashCode(boolean bool)` Return the same value as `Boolean.hashCode()`.
`static int`	`hashCode(double dbl)` Return the same value as `Double.hashCode()`.
`static int`	`hashCode(float flt)` Return the same value as `Float.hashCode()`.
`static int`	`hashCode(long lng)` Return the same value as `Long.hashCode()`.
`static String`	`identityToString(Object obj)` Return a String representation of an object's overall identity.
`static boolean`	`isArray(Object obj)` Returns `true` if the specified argument is an Object or primitive array, `false` otherwise.
`static boolean`	`isCheckedException(Throwable ex)` Return whether the given throwable is a checked exception: that is, neither a RuntimeException nor an Error.
`static boolean`	`isCompatibleWithThrowsClause(Throwable ex, Class[] declaredExceptions)` Check whether the given exception is compatible with the exceptions declared in a throws clause.
`static boolean`	`isEmpty(byte[] array)` Returns `true` if the specified byte array is null or of zero length, `false` if populated.
`static boolean`	`isEmpty(char[] chars)` Returns `true` if the specified character array is null or of zero length, `false` otherwise.
`static boolean`	`isEmpty(Object v)` Returns `true` if the specified argument: is `null`, or is a CharSequence and `Strings.hasText(CharSequence)` is `false`, or is a Collection or Map with zero size, or is an empty array
`static boolean`	`isEmpty(Object[] array)` `true` if the specified array is null or zero length, `false` if populated.
`static String`	`nullSafeClassName(Object obj)` Determine the class name for the given object.
`static void`	`nullSafeClose(Closeable... closeables)` Iterate over the specified `Closeable` instances, invoking `Closeable.close()` on each one, ignoring any potential `IOException`s.
`static boolean`	`nullSafeEquals(Object o1, Object o2)` Determine if the given objects are equal, returning `true` if both are `null` or `false` if only one is `null`.
`static void`	`nullSafeFlush(Flushable... flushables)` Iterate over the specified `Flushable` instances, invoking `Flushable.flush()` on each one, ignoring any potential `IOException`s.
`static int`	`nullSafeHashCode(boolean[] array)` Return a hash code based on the contents of the specified array.
`static int`	`nullSafeHashCode(byte[] array)` Return a hash code based on the contents of the specified array.
`static int`	`nullSafeHashCode(char[] array)` Return a hash code based on the contents of the specified array.
`static int`	`nullSafeHashCode(double[] array)` Return a hash code based on the contents of the specified array.
`static int`	`nullSafeHashCode(float[] array)` Return a hash code based on the contents of the specified array.
`static int`	`nullSafeHashCode(int[] array)` Return a hash code based on the contents of the specified array.
`static int`	`nullSafeHashCode(long[] array)` Return a hash code based on the contents of the specified array.
`static int`	`nullSafeHashCode(Object... array)` Return a hash code based on the contents of the specified array.
`static int`	`nullSafeHashCode(Object obj)` Return as hash code for the given object; typically the value of `Object.hashCode()`.
`static int`	`nullSafeHashCode(short[] array)` Return a hash code based on the contents of the specified array.
`static String`	`nullSafeToString(boolean[] array)` Return a String representation of the contents of the specified array.
`static String`	`nullSafeToString(byte[] array)` Return a String representation of the contents of the specified array.
`static String`	`nullSafeToString(char[] array)` Return a String representation of the contents of the specified array.
`static String`	`nullSafeToString(double[] array)` Return a String representation of the contents of the specified array.
`static String`	`nullSafeToString(float[] array)` Return a String representation of the contents of the specified array.
`static String`	`nullSafeToString(int[] array)` Return a String representation of the contents of the specified array.
`static String`	`nullSafeToString(long[] array)` Return a String representation of the contents of the specified array.
`static String`	`nullSafeToString(Object obj)` Return a String representation of the specified Object.
`static String`	`nullSafeToString(Object[] array)` Return a String representation of the contents of the specified array.
`static String`	`nullSafeToString(short[] array)` Return a String representation of the contents of the specified array.
`static Object[]`	`toObjectArray(Object source)` Convert the given array (which may be a primitive array) to an object array (if necessary of primitive wrapper objects).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - isCheckedException
```
public static boolean isCheckedException(Throwable ex)
```
    Return whether the given throwable is a checked exception: that is, neither a RuntimeException nor an Error.
    
    Parameters:
    ex - the throwable to check
    
    Returns:
    whether the throwable is a checked exception
    See Also:
    Exception, RuntimeException, Error
  - isCompatibleWithThrowsClause
```
public static boolean isCompatibleWithThrowsClause(Throwable ex,
                                   Class[] declaredExceptions)
```
    Check whether the given exception is compatible with the exceptions declared in a throws clause.
    
    Parameters:
    ex - the exception to checked
    declaredExceptions - the exceptions declared in the throws clause
    
    Returns:
    whether the given exception is compatible
  - isArray
```
public static boolean isArray(Object obj)
```
    Returns true if the specified argument is an Object or primitive array, false otherwise.
    
    Parameters:
    obj - the object instance to check
    
    Returns:
    true if the specified argument is an Object or primitive array, false otherwise.
  - isEmpty
```
public static boolean isEmpty(Object v)
```
    Returns true if the specified argument:
    1. is null, or
    2. is a CharSequence and Strings.hasText(CharSequence) is false, or
    3. is a Collection or Map with zero size, or
    4. is an empty array
    or false otherwise.
    Parameters:
    v - object to check
    
    Returns:
    true if the specified argument is empty, false otherwise.
    Since:
    
    0.12.0
  - isEmpty
```
public static boolean isEmpty(Object[] array)
```
    true if the specified array is null or zero length, false if populated.
    
    Parameters:
    array - the array to check
    
    Returns:
    true if the specified array is null or zero length, false if populated.
  - isEmpty
```
public static boolean isEmpty(byte[] array)
```
    Returns true if the specified byte array is null or of zero length, false if populated.
    
    Parameters:
    array - the byte array to check
    
    Returns:
    true if the specified byte array is null or of zero length, false if populated.
  - isEmpty
```
public static boolean isEmpty(char[] chars)
```
    Returns true if the specified character array is null or of zero length, false otherwise.
    
    Parameters:
    chars - the character array to check
    
    Returns:
    true if the specified character array is null or of zero length, false otherwise.
  - containsElement
```
public static boolean containsElement(Object[] array,
                      Object element)
```
    Check whether the given array contains the given element.
    
    Parameters:
    array - the array to check (may be null, in which case the return value will always be false)
    element - the element to check for
    
    Returns:
    whether the element has been found in the given array
  - containsConstant
```
public static boolean containsConstant(Enum<?>[] enumValues,
                       String constant)
```
    Check whether the given array of enum constants contains a constant with the given name, ignoring case when determining a match.
    
    Parameters:
    enumValues - the enum values to check, typically the product of a call to MyEnum.values()
    constant - the constant name to find (must not be null or empty string)
    
    Returns:
    whether the constant has been found in the given array
  - containsConstant
```
public static boolean containsConstant(Enum<?>[] enumValues,
                       String constant,
                       boolean caseSensitive)
```
    Check whether the given array of enum constants contains a constant with the given name.
    
    Parameters:
    enumValues - the enum values to check, typically the product of a call to MyEnum.values()
    constant - the constant name to find (must not be null or empty string)
    caseSensitive - whether case is significant in determining a match
    
    Returns:
    whether the constant has been found in the given array
  - caseInsensitiveValueOf
```
public static <E extends Enum<?>> E caseInsensitiveValueOf(E[] enumValues,
                                           String constant)
```
    Case insensitive alternative to Enum.valueOf(Class, String).
    
    Type Parameters:
    E - the concrete Enum type
    Parameters:
    enumValues - the array of all Enum constants in question, usually per Enum.values()
    constant - the constant to get the enum value of
    
    Returns:
    the enum constant of the specified enum type with the specified case-insensitive name
    
    Throws:
    
    IllegalArgumentException - if the given constant is not found in the given array of enum values. Use containsConstant(Enum[], String) as a guard to avoid this exception.
  - addObjectToArray
```
public static <A,O extends A> A[] addObjectToArray(A[] array,
                                   O obj)
```
    Append the given object to the given array, returning a new array consisting of the input array contents plus the given object.
    
    Type Parameters:
    A - the type of each element in the specified array
    O - the type of the specified object, which must be equal to or extend the <A> type.
    Parameters:
    array - the array to append to (can be null)
    obj - the object to append
    
    Returns:
    the new array (of the same component type; never null)
  - toObjectArray
```
public static Object[] toObjectArray(Object source)
```
    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.
    
    Parameters:
    source - the (potentially primitive) array
    
    Returns:
    the corresponding object array (never null)
    
    Throws:
    
    IllegalArgumentException - if the parameter is not an array
  - nullSafeEquals
```
public static boolean nullSafeEquals(Object o1,
                     Object o2)
```
    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.
    
    Parameters:
    o1 - first Object to compare
    o2 - second Object to compare
    
    Returns:
    whether the given objects are equal
    See Also:
    Arrays.equals(long[], long[])
  - nullSafeHashCode
```
public static int nullSafeHashCode(Object obj)
```
    Return as hash code for the given object; typically the value of 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.
    
    Parameters:
    obj - the object to use for obtaining a hashcode
    
    Returns:
    the object's hashcode, which could be 0 if the object is null.
    See Also:
    nullSafeHashCode(Object[]), nullSafeHashCode(boolean[]), nullSafeHashCode(byte[]), nullSafeHashCode(char[]), nullSafeHashCode(double[]), nullSafeHashCode(float[]), nullSafeHashCode(int[]), nullSafeHashCode(long[]), nullSafeHashCode(short[])
  - nullSafeHashCode
```
public static int nullSafeHashCode(Object... array)
```
    Return a hash code based on the contents of the specified array. If array is null, this method returns 0.
    
    Parameters:
    array - the array to obtain a hashcode
    
    Returns:
    the array's hashcode, which could be 0 if the array is null.
  - nullSafeHashCode
```
public static int nullSafeHashCode(boolean[] array)
```
    Return a hash code based on the contents of the specified array. If array is null, this method returns 0.
    
    Parameters:
    array - the boolean array to obtain a hashcode
    
    Returns:
    the boolean array's hashcode, which could be 0 if the array is null.
  - nullSafeHashCode
```
public static int nullSafeHashCode(byte[] array)
```
    Return a hash code based on the contents of the specified array. If array is null, this method returns 0.
    
    Parameters:
    array - the byte array to obtain a hashcode
    
    Returns:
    the byte array's hashcode, which could be 0 if the array is null.
  - nullSafeHashCode
```
public static int nullSafeHashCode(char[] array)
```
    Return a hash code based on the contents of the specified array. If array is null, this method returns 0.
    
    Parameters:
    array - the char array to obtain a hashcode
    
    Returns:
    the char array's hashcode, which could be 0 if the array is null.
  - nullSafeHashCode
```
public static int nullSafeHashCode(double[] array)
```
    Return a hash code based on the contents of the specified array. If array is null, this method returns 0.
    
    Parameters:
    array - the double array to obtain a hashcode
    
    Returns:
    the double array's hashcode, which could be 0 if the array is null.
  - nullSafeHashCode
```
public static int nullSafeHashCode(float[] array)
```
    Return a hash code based on the contents of the specified array. If array is null, this method returns 0.
    
    Parameters:
    array - the float array to obtain a hashcode
    
    Returns:
    the float array's hashcode, which could be 0 if the array is null.
  - nullSafeHashCode
```
public static int nullSafeHashCode(int[] array)
```
    Return a hash code based on the contents of the specified array. If array is null, this method returns 0.
    
    Parameters:
    array - the int array to obtain a hashcode
    
    Returns:
    the int array's hashcode, which could be 0 if the array is null.
  - nullSafeHashCode
```
public static int nullSafeHashCode(long[] array)
```
    Return a hash code based on the contents of the specified array. If array is null, this method returns 0.
    
    Parameters:
    array - the long array to obtain a hashcode
    
    Returns:
    the long array's hashcode, which could be 0 if the array is null.
  - nullSafeHashCode
```
public static int nullSafeHashCode(short[] array)
```
    Return a hash code based on the contents of the specified array. If array is null, this method returns 0.
    
    Parameters:
    array - the short array to obtain a hashcode
    
    Returns:
    the short array's hashcode, which could be 0 if the array is null.
  - hashCode
```
public static int hashCode(boolean bool)
```
    Return the same value as Boolean.hashCode().
    
    Parameters:
    bool - the boolean to get a hashcode
    
    Returns:
    the same value as Boolean.hashCode().
    See Also:
    Boolean.hashCode()
  - hashCode
```
public static int hashCode(double dbl)
```
    Return the same value as Double.hashCode().
    
    Parameters:
    dbl - the double to get a hashcode
    
    Returns:
    the same value as Double.hashCode().
    See Also:
    Double.hashCode()
  - hashCode
```
public static int hashCode(float flt)
```
    Return the same value as Float.hashCode().
    
    Parameters:
    flt - the float to get a hashcode
    
    Returns:
    the same value as Float.hashCode().
    See Also:
    Float.hashCode()
  - hashCode
```
public static int hashCode(long lng)
```
    Return the same value as Long.hashCode().
    
    Parameters:
    lng - the long to get a hashcode
    
    Returns:
    the same value as Long.hashCode().
    See Also:
    Long.hashCode()
  - identityToString
```
public static String identityToString(Object obj)
```
    Return a String representation of an object's overall identity.
    
    Parameters:
    obj - the object (which may be null).
    
    Returns:
    the object's identity as String representation, or an empty String if the object was null.
  - getIdentityHexString
```
public static String getIdentityHexString(Object obj)
```
    Return a hex String form of an object's identity hash code.
    
    Parameters:
    obj - the object
    
    Returns:
    the object's identity code in hex notation
  - getDisplayString
```
public static String getDisplayString(Object obj)
```
    Return a content-based String representation if obj is not null; otherwise returns an empty String.
    Differs from nullSafeToString(Object) in that it returns an empty String rather than "null" for a null value.
    
    Parameters:
    obj - the object to build a display String for
    
    Returns:
    a display String representation of obj
    See Also:
    nullSafeToString(Object)
  - nullSafeClassName
```
public static String nullSafeClassName(Object obj)
```
    Determine the class name for the given object.
    Returns "null" if obj is null.
    
    Parameters:
    obj - the object to introspect (may be null)
    
    Returns:
    the corresponding class name
  - nullSafeToString
```
public static String nullSafeToString(Object obj)
```
    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.
    
    Parameters:
    obj - the object to build a String representation for
    
    Returns:
    a String representation of obj
  - nullSafeToString
```
public static String nullSafeToString(Object[] array)
```
    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.
    
    Parameters:
    array - the array to build a String representation for
    
    Returns:
    a String representation of array
  - nullSafeToString
```
public static String nullSafeToString(boolean[] array)
```
    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.
    
    Parameters:
    array - the array to build a String representation for
    
    Returns:
    a String representation of array
  - nullSafeToString
```
public static String nullSafeToString(byte[] array)
```
    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.
    
    Parameters:
    array - the array to build a String representation for
    
    Returns:
    a String representation of array
  - nullSafeToString
```
public static String nullSafeToString(char[] array)
```
    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.
    
    Parameters:
    array - the array to build a String representation for
    
    Returns:
    a String representation of array
  - nullSafeToString
```
public static String nullSafeToString(double[] array)
```
    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.
    
    Parameters:
    array - the array to build a String representation for
    
    Returns:
    a String representation of array
  - nullSafeToString
```
public static String nullSafeToString(float[] array)
```
    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.
    
    Parameters:
    array - the array to build a String representation for
    
    Returns:
    a String representation of array
  - nullSafeToString
```
public static String nullSafeToString(int[] array)
```
    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.
    
    Parameters:
    array - the array to build a String representation for
    
    Returns:
    a String representation of array
  - nullSafeToString
```
public static String nullSafeToString(long[] array)
```
    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.
    
    Parameters:
    array - the array to build a String representation for
    
    Returns:
    a String representation of array
  - nullSafeToString
```
public static String nullSafeToString(short[] array)
```
    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.
    
    Parameters:
    array - the array to build a String representation for
    
    Returns:
    a String representation of array
  - nullSafeClose
```
public static void nullSafeClose(Closeable... closeables)
```
    Iterate over the specified Closeable instances, invoking Closeable.close() on each one, ignoring any potential IOExceptions.
    
    Parameters:
    closeables - the closeables to close.
  - nullSafeFlush
```
public static void nullSafeFlush(Flushable... flushables)
```
    Iterate over the specified Flushable instances, invoking Flushable.flush() on each one, ignoring any potential IOExceptions.
    
    Parameters:
    flushables - the flushables to flush.
    Since:
    
    0.12.0

Class Objects

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isCheckedException

isCompatibleWithThrowsClause

isArray

isEmpty

isEmpty

isEmpty

isEmpty

containsElement

containsConstant

containsConstant

caseInsensitiveValueOf

addObjectToArray

toObjectArray

nullSafeEquals

nullSafeHashCode

nullSafeHashCode

nullSafeHashCode

nullSafeHashCode

nullSafeHashCode

nullSafeHashCode

nullSafeHashCode

nullSafeHashCode

nullSafeHashCode

nullSafeHashCode

hashCode

hashCode

hashCode

hashCode

identityToString

getIdentityHexString

getDisplayString

nullSafeClassName

nullSafeToString

nullSafeToString

nullSafeToString

nullSafeToString

nullSafeToString

nullSafeToString

nullSafeToString

nullSafeToString

nullSafeToString

nullSafeToString

nullSafeClose

nullSafeFlush