com.alee.api.jdk

Class Objects

java.lang.Object

com.alee.api.jdk.Objects

public final class Objects
extends Object

This is a copy of JDK7 java.util.Objects class for JDK6 support.

Author:

Mikle Garin

Method Summary

Modifier and Type	Method and Description
static boolean	equals(Object object, Object... compareWith) Returns whether the first Object equals to any Object from the specified array.
static boolean	equals(Object object, Object compareWith) Returns whether the first Object equals to second one.
static int	hash(Object... values) Generates a hash code for a sequence of input values.
static boolean	notEquals(Object object, Object... compareWith) Returns whether the first Object is not equals to any Object from the specified array.
static boolean	notEquals(Object object, Object compareWith) Returns whether the first Object is not equals to the second one.
static <T> T	requireNonNull(T object) Checks that the specified Object is not null and throws a NullPointerException if it is.
static <T> T	requireNonNull(T object, String message) Checks that the specified Object is not null and throws a customized NullPointerException if it is.
static <T> T	requireNonNull(T object, Supplier<RuntimeException> exceptionSupplier) Checks that the specified Object is not null and throws a customized RuntimeException if it is.

Methods inherited from class java.lang.Object

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

Method Detail

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 Arrays.hashCode(Object[]).

Parameters:

values - the values to be hashed

Returns:

a hash value of the sequence of input values

See Also:

Arrays.hashCode(Object[])

equals

public static boolean equals(@Nullable
                             Object object,
                             @Nullable
                             Object compareWith)

Returns whether the first Object equals to second one. This method will compare objects even if they are null without throwing any exceptions. This method should not be called from any method that overrides object default "equals" method.

Parameters:

object - object to compare

compareWith - objects to compare with

Returns:

true if the first Object equals to any Object from the specified array, false otherwise

equals

public static boolean equals(@Nullable
                             Object object,
                             @Nullable
                             Object... compareWith)

Returns whether the first Object equals to any Object from the specified array. This method will compare objects even if they are null without throwing any exceptions. This method should not be called from any method that overrides object default "equals" method.

Parameters:

object - object to compare

compareWith - object to compare with

Returns:

true if the first Object equals to any Object from the specified array, false otherwise

notEquals

public static boolean notEquals(@Nullable
                                Object object,
                                @Nullable
                                Object compareWith)

Returns whether the first Object is not equals to the second one. This method will compare objects even if they are null without throwing any exceptions. This method should not be called from any method that overrides object default "equals" method.

Parameters:

object - object to compare

compareWith - object to compare with

Returns:

true if the first Object is not equals to any Object from the specified array, false otherwise

notEquals

public static boolean notEquals(@Nullable
                                Object object,
                                @Nullable
                                Object... compareWith)

Returns whether the first Object is not equals to any Object from the specified array. This method will compare objects even if they are null without throwing any exceptions. This method should not be called from any method that overrides object default "equals" method.

Parameters:

object - object to compare

compareWith - objects to compare with

Returns:

true if the first Object is not equals to any Object from the specified array, false otherwise

requireNonNull

@NotNull
public static <T> T requireNonNull(@Nullable
                                            T object)

Checks that the specified Object is not null and throws a NullPointerException if it is.

Type Parameters:

T - Object type

Parameters:

object - Object to check for being null

Returns:

Object if not null

Throws:

NullPointerException - if Object is null

requireNonNull

@NotNull
public static <T> T requireNonNull(@Nullable
                                            T object,
                                            @NotNull
                                            String message)

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

Type Parameters:

T - Object type

Parameters:

object - Object to check for being null

message - detailed message used in NullPointerException

Returns:

Object if not null

Throws:

NullPointerException - if Object is null

requireNonNull

@NotNull
public static <T> T requireNonNull(@Nullable
                                            T object,
                                            @NotNull
                                            Supplier<RuntimeException> exceptionSupplier)

Checks that the specified Object is not null and throws a customized RuntimeException if it is.

Type Parameters:

T - Object type

Parameters:

object - Object to check for being null

exceptionSupplier - Supplier for a customized RuntimeException

Returns:

Object if not null

Throws:

RuntimeException - if Object is null