ObjectUtils¶

@SuppressWarnings({"deprecation"}) public class org.apache.commons.lang3.ObjectUtils[source]¶

Operations on Object.

This class tries to handle null input gracefully. An exception will generally not be thrown for a null input. Each method documents its behavior in more detail.

#ThreadSafe#

See also:

Since:

1.0

Constructors¶

ObjectUtils()

Deprecated. ObjectUtils instances should NOT be constructed in standard programming.

@Deprecated public ObjectUtils()[source]¶

Deprecated: TODO Make private in 4.0.

ObjectUtils instances should NOT be constructed in standard programming. Instead, the static methods on the class should be used, such as ObjectUtils.defaultIfNull("a","b");.

This constructor is public to permit tools that require a JavaBean instance to operate.

Fields and constants¶

NULL

Singleton used as a null placeholder where null has another meaning.

public static final ObjectUtils.Null NULL[source]¶

Singleton used as a null placeholder where null has another meaning.

For example, in a HashMap the java.util.HashMap#get(Object) method returns null if the Map contains null or if there is no matching key. The null placeholder can be used to distinguish between these two cases.

Another example is Hashtable, where null cannot be stored.

This instance is Serializable.

Methods¶

`CONST(boolean)`	Returns the provided value unchanged.
`CONST(byte)`	Returns the provided value unchanged.
`CONST(char)`	Returns the provided value unchanged.
`CONST(double)`	Returns the provided value unchanged.
`CONST(float)`	Returns the provided value unchanged.
`CONST(int)`	Returns the provided value unchanged.
`CONST(Object)`	Returns the provided value unchanged.
`CONST(long)`	Returns the provided value unchanged.
`CONST(short)`	Returns the provided value unchanged.
`CONST_BYTE(int)`	Returns the provided value unchanged.
`CONST_SHORT(int)`	Returns the provided value unchanged.
`allNotNull(Object[])`	Tests if all values in the array are not `nulls`.
`allNull(Object[])`	Tests if all values in the given array are `null`.
`anyNotNull(Object[])`	Tests if any value in the given array is not `null`.
`anyNull(Object[])`	Tests if any value in the given array is `null`.
`clone(Object)`	Clones an object.
`cloneIfPossible(Object)`	Clones an object if possible.
`compare(Comparable, Comparable)`	Null safe comparison of Comparables.
`compare(Comparable, Comparable, boolean)`	Null safe comparison of Comparables.
`defaultIfNull(Object, Object)`	Deprecated. Returns a default value if the object passed is `null`.
`equals(Object, Object)`	Deprecated. Compares two objects for equality, where either one or both objects may be `null`.
`firstNonNull(Object[])`	Returns the first value in the array which is not `null`.
`getClass(Object)`	Gets the object’s class using `Object#getClass()` with generics.
`getFirstNonNull(Supplier[])`	Gets the first non-null result from the given suppliers.
`getIfNull(Object, Object)`	Gets the given object, or the default value if the object is `null`.
`getIfNull(Object, Supplier)`	Gets the given `object` if it is non-null; otherwise, gets the value from `Supplier#get()`.
`hashCode(Object)`	Deprecated. Gets the hash code of an object returning zero when the object is `null`.
`hashCodeHex(Object)`	Returns the hexadecimal hash code for the given object per `Objects#hashCode(Object)`.
`hashCodeMulti(Object[])`	Deprecated. Gets the hash code for multiple objects.
`identityHashCodeHex(Object)`	Returns the hexadecimal hash code for the given object per `System#identityHashCode(Object)`.
`identityToString(Appendable, Object)`	Appends the toString that would be produced by `Object` if a class did not override toString itself.
`identityToString(Object)`	Gets the toString that would be produced by `Object` if a class did not override toString itself.
`identityToString(StringBuffer, Object)`	Appends the toString that would be produced by `Object` if a class did not override toString itself.
`identityToString(StringBuilder, Object)`	Appends the toString that would be produced by `Object` if a class did not override toString itself.
`identityToString(StrBuilder, Object)`	Deprecated. Appends the toString that would be produced by `Object` if a class did not override toString itself.
`isArray(Object)`	Tests whether the given object is an Object array or a primitive array in a null-safe manner.
`isEmpty(Object)`	Tests if an Object is empty or null.
`isNotEmpty(Object)`	Tests if an Object is not empty and not null.
`max(Comparable[])`	Null safe comparison of Comparables.
`median(Comparable[])`	Finds the “best guess” middle value among comparables.
`median(Comparator, Object[])`	Finds the “best guess” middle value among comparables.
`min(Comparable[])`	Null safe comparison of Comparables.
`mode(Object[])`	Finds the most frequently occurring item.
`notEqual(Object, Object)`	Compares two objects for inequality, where either one or both objects may be `null`.
`requireNonEmpty(Object)`	Checks that the specified object reference is not `null` or empty per `#isEmpty(Object)`.
`requireNonEmpty(Object, String)`	Checks that the specified object reference is not `null` or empty per `#isEmpty(Object)`.
`toString(Object)`	Gets the `toString()` of an `Object` or the empty string (`""`) if the input is `null`.
`toString(Object, String)`	Deprecated. Gets the `toString` of an `Object` returning a specified text if `null` input.
`toString(Object, Supplier)`	Gets the `toString` of an `Object` returning a specified text if `null` input.
`toString(Supplier, Supplier)`	Gets the `toString` of an `Supplier`’s `Supplier#get()` returning a specified text if `null` input.
`wait(Object, Duration)`	Calls `Object#wait(long, int)` for the given Duration.

public static boolean CONST(boolean v)[source]¶

Returns the provided value unchanged. This can prevent javac from inlining a constant field, e.g.,

public final static boolean MAGIC_FLAG = ObjectUtils.CONST(true);