java8.util

Class Objects

java.lang.Object

java8.util.Objects

public final class Objects
extends java.lang.Object

This class consists of static utility methods for operating on objects. These utilities include null-safe or null-tolerant methods for computing the hash code of an object, returning a string for an object, and comparing two objects.

Since:

1.7

Method Summary

Modifier and Type	Method and Description
static <T> int	compare(T a, T b, java.util.Comparator<? super T> c) Returns 0 if the arguments are identical and c.compare(a, b) otherwise.
static boolean	deepEquals(java.lang.Object a, java.lang.Object b) Returns true if the arguments are deeply equal to each other and false otherwise.
static boolean	equals(java.lang.Object a, java.lang.Object b) Returns true if the arguments are equal to each other and false otherwise.
static int	hash(java.lang.Object... values) Generates a hash code for a sequence of input values.
static int	hashCode(java.lang.Object o) Returns the hash code of a non-null argument and 0 for a null argument.
static boolean	isNull(java.lang.Object obj) Returns true if the provided reference is null otherwise returns false.
static boolean	nonNull(java.lang.Object obj) Returns true if the provided reference is non-null otherwise returns false.
static <T> T	requireNonNull(T obj) Checks that the specified object reference is not null.
static <T> T	requireNonNull(T obj, java.lang.String message) Checks that the specified object reference is not null and throws a customized NullPointerException if it is.
static <T> T	requireNonNull(T obj, Supplier<java.lang.String> messageSupplier) Checks that the specified object reference is not null and throws a customized NullPointerException if it is.
static java.lang.String	toString(java.lang.Object o) Returns the result of calling toString for a non-null argument and "null" for a null argument.
static java.lang.String	toString(java.lang.Object o, java.lang.String nullDefault) Returns the result of calling toString on the first argument if the first argument is not null and returns the second argument otherwise.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

equals

public static boolean equals(java.lang.Object a,
                             java.lang.Object b)

Returns true if the arguments are equal to each other and false otherwise. Consequently, if both arguments are null, true is returned and if exactly one argument is null, false is returned. Otherwise, equality is determined by using the equals method of the first argument.

Parameters:

a - an object

b - an object to be compared with a for equality

Returns:

true if the arguments are equal to each other and false otherwise

See Also:

Object.equals(Object)

deepEquals

public static boolean deepEquals(java.lang.Object a,
                                 java.lang.Object b)

Returns true if the arguments are deeply equal to each other and false otherwise. Two null values are deeply equal. If both arguments are arrays, the algorithm in Arrays.deepEquals is used to determine equality. Otherwise, equality is determined by using the equals method of the first argument.

Parameters:

a - an object

b - an object to be compared with a for deep equality

Returns:

true if the arguments are deeply equal to each other and false otherwise

See Also:

Arrays.deepEquals(Object[], Object[]), equals(Object, Object)

hashCode

public static int hashCode(java.lang.Object o)

Returns the hash code of a non-null argument and 0 for a null argument.

Parameters:

o - an object

Returns:

the hash code of a non-null argument and 0 for a null argument

See Also:

Object.hashCode()

hash

public static int hash(java.lang.Object... values)

Generates a hash code for a sequence of input values. The hash code is generated as if all the input values were placed into an array, and that array were hashed by calling Arrays.hashCode(Object[]).

This method is useful for implementing Object.hashCode() on objects containing multiple fields. For example, if an object that has three fields, x, y, and z, one could write:

 @Override public int hashCode() {
     return Objects.hash(x, y, z);
 }
 

Warning: When a single object reference is supplied, the returned value does not equal the hash code of that object reference. This value can be computed by calling hashCode(Object).

Parameters:

values - the values to be hashed

Returns:

a hash value of the sequence of input values

See Also:

Arrays.hashCode(Object[]), List.hashCode()

toString

public static java.lang.String toString(java.lang.Object o)

Returns the result of calling toString for a non-null argument and "null" for a null argument.

Parameters:

o - an object

Returns:

the result of calling toString for a non-null argument and "null" for a null argument

See Also:

Object.toString(), String.valueOf(Object)

toString

public static java.lang.String toString(java.lang.Object o,
                                        java.lang.String nullDefault)

Returns the result of calling toString on the first argument if the first argument is not null and returns the second argument otherwise.

Parameters:

o - an object

nullDefault - string to return if the first argument is null

Returns:

the result of calling toString on the first argument if it is not null and the second argument otherwise.

See Also:

toString(Object)

compare

public static <T> int compare(T a,
                              T b,
                              java.util.Comparator<? super T> c)

Returns 0 if the arguments are identical and c.compare(a, b) otherwise. Consequently, if both arguments are null 0 is returned.

Note that if one of the arguments is null, a NullPointerException may or may not be thrown depending on what ordering policy, if any, the Comparator chooses to have for null values.

Type Parameters:

T - the type of the objects being compared

Parameters:

a - an object

b - an object to be compared with a

c - the Comparator to compare the first two arguments

Returns:

0 if the arguments are identical and c.compare(a, b) otherwise.

See Also:

Comparable, Comparator

requireNonNull

public static <T> T requireNonNull(T obj)

Checks that the specified object reference is not null. This method is designed primarily for doing parameter validation in methods and constructors, as demonstrated below:

 public Foo(Bar bar) {
     this.bar = Objects.requireNonNull(bar);
 }
 

Type Parameters:

T - the type of the reference

Parameters:

obj - the object reference to check for nullity

Returns:

obj if not null

Throws:

java.lang.NullPointerException - if obj is null

requireNonNull

public static <T> T requireNonNull(T obj,
                                   java.lang.String message)

Checks that the specified object reference is not null and throws a customized NullPointerException if it is. This method is designed primarily for doing parameter validation in methods and constructors with multiple parameters, as demonstrated below:

 public Foo(Bar bar, Baz baz) {
     this.bar = Objects.requireNonNull(bar, "bar must not be null");
     this.baz = Objects.requireNonNull(baz, "baz must not be null");
 }
 

Type Parameters:

T - the type of the reference

Parameters:

obj - the object reference to check for nullity

message - detail message to be used in the event that a NullPointerException is thrown

Returns:

obj if not null

Throws:

java.lang.NullPointerException - if obj is null

isNull

public static boolean isNull(java.lang.Object obj)

Returns true if the provided reference is null otherwise returns false.

API Note:
This method exists to be used as a Predicate, filter(Objects::isNull)

Parameters:

obj - a reference to be checked against null

Returns:

true if the provided reference is null otherwise false

Since:

1.8

See Also:

Predicate

nonNull

public static boolean nonNull(java.lang.Object obj)

Returns true if the provided reference is non-null otherwise returns false.

API Note:
This method exists to be used as a Predicate, filter(Objects::nonNull)

Parameters:

obj - a reference to be checked against null

Returns:

true if the provided reference is non-null otherwise false

Since:

1.8

See Also:

Predicate

requireNonNull

public static <T> T requireNonNull(T obj,
                                   Supplier<java.lang.String> messageSupplier)

Checks that the specified object reference is not null and throws a customized NullPointerException if it is.

Unlike the method requireNonNull(Object, String), this method allows creation of the message to be deferred until after the null check is made. While this may confer a performance advantage in the non-null case, when deciding to call this method care should be taken that the costs of creating the message supplier are less than the cost of just creating the string message directly.

Type Parameters:

T - the type of the reference

Parameters:

obj - the object reference to check for nullity

messageSupplier - supplier of the detail message to be used in the event that a NullPointerException is thrown

Returns:

obj if not null

Throws:

java.lang.NullPointerException - if obj is null

Since:

1.8