ObjectsCompat
public class ObjectsCompat
This class consists of static utility methods for operating on objects.
Summary
Public methods |
|
|---|---|
static boolean |
Returns |
static int |
Generates a hash code for a sequence of input values. |
static int |
Returns the hash code of a non- |
static @NonNull T |
<T> requireNonNull(@Nullable T obj)Checks that the specified object reference is not |
static @NonNull T |
<T> requireNonNull(@Nullable T obj, @NonNull String message)Checks that the specified object reference is not |
static @Nullable String |
Returns the result of calling |
Public methods
equals
public static boolean equals(@Nullable Object a, @Nullable 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 | |
|---|---|
@Nullable Object a |
an object |
@Nullable Object b |
an object to be compared with |
| Returns | |
|---|---|
boolean |
|
| See also | |
|---|---|
equals |
hash
public static int hash(@Nullable 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 hashCode.
This method is useful for implementing hashCode on objects containing multiple fields. For example, if an object that has three fields, x, y, and z, one could write:
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 @Override public int hashCode() { return ObjectsCompat.hash(x, y, z); }
hashCode.
| Parameters | |
|---|---|
@Nullable Object[] values |
the values to be hashed |
| Returns | |
|---|---|
int |
a hash value of the sequence of input values |
| See also | |
|---|---|
hashCode |
hashCode
public static int hashCode(@Nullable Object o)
Returns the hash code of a non-null argument and 0 for a null argument.
| Returns | |
|---|---|
int |
the hash code of a non- |
| See also | |
|---|---|
hashCode |
requireNonNull
public static @NonNull T <T> requireNonNull(@Nullable 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); }
| Parameters | |
|---|---|
<T> |
the type of the reference |
@Nullable T obj |
the object reference to check for nullity |
| Returns | |
|---|---|
@NonNull T |
|
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
requireNonNull
public static @NonNull T <T> requireNonNull(@Nullable T obj, @NonNull 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"); }
| Parameters | |
|---|---|
<T> |
the type of the reference |
@Nullable T obj |
the object reference to check for nullity |
@NonNull String message |
detail message to be used in the event that a |
| Returns | |
|---|---|
@NonNull T |
|
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
toString
public static @Nullable String toString(@Nullable Object o, @Nullable 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.