org.springframework.geode.core.util

Class ObjectUtils

java.lang.Object

org.springframework.util.ObjectUtils

org.springframework.geode.core.util.ObjectUtils

public abstract class ObjectUtils
extends org.springframework.util.ObjectUtils

The ObjectUtils class is an abstract utility class with operations for objects.

Since:

1.0.0

See Also:

Object, Constructor, Field, Method, PdxInstance

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ObjectUtils.ExceptionThrowingOperation<T>

Constructor Summary

Constructors

Constructor and Description
ObjectUtils()

Method Summary

Modifier and Type	Method and Description
static <T> T	asType(java.lang.Object source, java.lang.Class<T> type) Tries to cast the given source Object into an instance of the given Class type.
static <T> T	doOperationSafely(ObjectUtils.ExceptionThrowingOperation<T> operation) Safely executes the given ObjectUtils.ExceptionThrowingOperation handling any checked Exception thrown during the normal execution of the operation by rethrowing an IllegalStateException wrapping the original checked Exception.
static <T> T	doOperationSafely(ObjectUtils.ExceptionThrowingOperation<T> operation, java.util.function.Function<java.lang.Throwable,T> exceptionHandlingFunction) Safely executes the given ObjectUtils.ExceptionThrowingOperation handling any checked Exception thrown during the normal execution of the operation by invoking the provided Exception handling Function.
static <T> T	doOperationSafely(ObjectUtils.ExceptionThrowingOperation<T> operation, java.util.function.Supplier<T> valueSupplier) Safely executes the given ObjectUtils.ExceptionThrowingOperation handling any checked Exception thrown during the normal execution of the operation by returning a default value supplied by the given Supplier, or throws an IllegalStateException if the supplied value is null.
static <T> T	doOperationSafely(ObjectUtils.ExceptionThrowingOperation<T> operation, T defaultValue) Safely executes the given ObjectUtils.ExceptionThrowingOperation handling any checked Exception thrown during the normal execution of the operation by returning the given default value or throwing an IllegalStateException if the default value is null.
static java.util.Optional<java.lang.reflect.Method>	findMethod(java.lang.Class<?> type, java.lang.String methodName, java.lang.Object... args) Finds a Method with the given name on type which can be invoked with the given arguments.
static <T> T	get(java.lang.Object obj, java.lang.reflect.Field field) Gets the value of the given Field on the given Object.
static <T> T	get(java.lang.Object obj, java.lang.String fieldName) Gets the value of the given named Field on the given Object.
static <T> T	initialize(T target, java.util.function.Supplier<T> supplier) An initialization operator used to evalutate a given target and conditionally supply a new value if the target is null.
static <T> T	invoke(java.lang.Object obj, java.lang.String methodName) Invokes a Method on an Object with the given name.
static java.lang.reflect.Constructor<?>	makeAccessible(java.lang.reflect.Constructor<?> constructor) Makes the Constructor accessible.
static java.lang.reflect.Field	makeAccessible(java.lang.reflect.Field field) Makes the Field accessible.
static java.lang.reflect.Method	makeAccessible(java.lang.reflect.Method method) Makes the Method accessible.
static <T> T	resolveInvocationTarget(T target, java.lang.reflect.Method method) Resolves the invocation target for the given Method.
static <T> T	returnValueThrowOnNull(T value) Returns the given value or throws an IllegalArgumentException if value is null.
static <T> T	returnValueThrowOnNull(T value, java.lang.RuntimeException exception) Returns the given value or throws the given RuntimeException if value is null.

Methods inherited from class org.springframework.util.ObjectUtils

addObjectToArray, caseInsensitiveValueOf, containsConstant, containsConstant, containsElement, getDisplayString, getIdentityHexString, hashCode, hashCode, hashCode, hashCode, identityToString, isArray, isCheckedException, isCompatibleWithThrowsClause, isEmpty, isEmpty, nullSafeClassName, nullSafeEquals, nullSafeHashCode, nullSafeHashCode, nullSafeHashCode, nullSafeHashCode, nullSafeHashCode, nullSafeHashCode, nullSafeHashCode, nullSafeHashCode, nullSafeHashCode, nullSafeHashCode, nullSafeToString, nullSafeToString, nullSafeToString, nullSafeToString, nullSafeToString, nullSafeToString, nullSafeToString, nullSafeToString, nullSafeToString, nullSafeToString, toObjectArray, unwrapOptional

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectUtils

public ObjectUtils()

Method Detail

asType

@Nullable
public static <T> T asType(@Nullable
                                     java.lang.Object source,
                                     @NonNull
                                     java.lang.Class<T> type)

Tries to cast the given source Object into an instance of the given Class type. This method is cable of handling Apache Geode PdxInstance types.

Type Parameters:

T - desired type of the source Object.

Parameters:

source - Object to evaluate.

type - desired target Class type; must not be null.

Returns:

the source Object cast to an instance of the given Class type.

Throws:

java.lang.IllegalArgumentException - if the source Object is not an instance of the given Class type or the Class type is null.

See Also:

PdxInstance, Class, Object

doOperationSafely

@Nullable
public static <T> T doOperationSafely(@NonNull
                                                ObjectUtils.ExceptionThrowingOperation<T> operation)

Safely executes the given ObjectUtils.ExceptionThrowingOperation handling any checked Exception thrown during the normal execution of the operation by rethrowing an IllegalStateException wrapping the original checked Exception.

Type Parameters:

T - type of value returned from the execution of the operation.

Parameters:

operation - ObjectUtils.ExceptionThrowingOperation to execute; must not be null.

Returns:

the result of the ObjectUtils.ExceptionThrowingOperation.

Throws:

java.lang.IllegalStateException - wrapping any checked Exception thrown by the operation.

See Also:

ObjectUtils.ExceptionThrowingOperation, doOperationSafely(ExceptionThrowingOperation, Object)

doOperationSafely

@Nullable
public static <T> T doOperationSafely(@NonNull
                                                ObjectUtils.ExceptionThrowingOperation<T> operation,
                                                @NonNull
                                                T defaultValue)

Safely executes the given ObjectUtils.ExceptionThrowingOperation handling any checked Exception thrown during the normal execution of the operation by returning the given default value or throwing an IllegalStateException if the default value is null.

Type Parameters:

T - type of value returned from the execution of the operation as well as the type of the default value.

Parameters:

operation - ObjectUtils.ExceptionThrowingOperation to execute; must not be null.

defaultValue - value to return if the execution of the operation results in a checked Exception.

Returns:

the result of the ObjectUtils.ExceptionThrowingOperation, returning the default value if the execution of the operation throws a checked Exception

Throws:

java.lang.IllegalStateException - wrapping any checked Exception thrown by the operation when the default value is null.

See Also:

ObjectUtils.ExceptionThrowingOperation, doOperationSafely(ExceptionThrowingOperation, Supplier), returnValueThrowOnNull(Object, RuntimeException)

doOperationSafely

public static <T> T doOperationSafely(@NonNull
                                      ObjectUtils.ExceptionThrowingOperation<T> operation,
                                      @NonNull
                                      java.util.function.Supplier<T> valueSupplier)

Safely executes the given ObjectUtils.ExceptionThrowingOperation handling any checked Exception thrown during the normal execution of the operation by returning a default value supplied by the given Supplier, or throws an IllegalStateException if the supplied value is null.

Type Parameters:

T - type of value returned from the execution of the operation as well as the type of the default value.

Parameters:

operation - ObjectUtils.ExceptionThrowingOperation to execute; must not be null.

valueSupplier - Supplier of the value to return if the execution of the operation results in a checked Exception; must not be null.

Returns:

the result of the ObjectUtils.ExceptionThrowingOperation, returning the supplied value if the execution of the operation throws a checked Exception

Throws:

java.lang.IllegalStateException - wrapping any checked Exception thrown by the operation when the supplied value is null.

See Also:

ObjectUtils.ExceptionThrowingOperation, doOperationSafely(ExceptionThrowingOperation, Function), returnValueThrowOnNull(Object, RuntimeException), Supplier

doOperationSafely

public static <T> T doOperationSafely(@NonNull
                                      ObjectUtils.ExceptionThrowingOperation<T> operation,
                                      @NonNull
                                      java.util.function.Function<java.lang.Throwable,T> exceptionHandlingFunction)

Safely executes the given ObjectUtils.ExceptionThrowingOperation handling any checked Exception thrown during the normal execution of the operation by invoking the provided Exception handling Function.

Type Parameters:

T - type of value returned from the execution of the operation.

Parameters:

operation - ObjectUtils.ExceptionThrowingOperation to execute; must not be null.

exceptionHandlingFunction - Function used to handle any checked Exception thrown by ObjectUtils.ExceptionThrowingOperation; must not be null.

Returns:

the result of the ObjectUtils.ExceptionThrowingOperation.

See Also:

ObjectUtils.ExceptionThrowingOperation, Function, Throwable

findMethod

public static java.util.Optional<java.lang.reflect.Method> findMethod(@NonNull
                                                                      java.lang.Class<?> type,
                                                                      @NonNull
                                                                      java.lang.String methodName,
                                                                      java.lang.Object... args)

Finds a Method with the given name on type which can be invoked with the given arguments.

Parameters:

type - Class type to evaluate for the Method.

methodName - String containing the name of the Method to find.

args - array of arguments used when invoking the method.

Returns:

an Optional Method on type potentially matching the arguments of the invocation.

See Also:

Class, Method, Optional

get

public static <T> T get(java.lang.Object obj,
                        java.lang.String fieldName)

Gets the value of the given named Field on the given Object.

Type Parameters:

T - type of the Field's value.

Parameters:

obj - Object containing the named Field.

fieldName - String containing the name of the Field.

Returns:

the value of the named Field on the given Object.

Throws:

java.lang.IllegalArgumentException - if Object is null, the named Field is not specified or the given Object contains no Field with the given name.

See Also:

get(Object, Field), Object

get

public static <T> T get(java.lang.Object obj,
                        java.lang.reflect.Field field)

Gets the value of the given Field on the given Object.

Type Parameters:

T - type of the Field's value.

Parameters:

obj - Object containing the Field.

field - Field of the given Object.

Returns:

the value of the Field on the given Object.

Throws:

java.lang.IllegalArgumentException - if Object or Field is null.

See Also:

Field, Object

initialize

public static <T> T initialize(@Nullable
                               T target,
                               @NonNull
                               java.util.function.Supplier<T> supplier)

An initialization operator used to evalutate a given target and conditionally supply a new value if the target is null. The initialize operator simplifies a common initialization safety pattern that appears in code as: target = target != null ? target : new Target(); While the expression uses Java's ternary operator, users could very well use a if-then-else statement instead. Either way, since Java is call-by-value then the above statement and expression can be replaced with: target = initialize(target, Target::new);

Type Parameters:

T - type of the target.

Parameters:

target - Object to evaluate and initialize; must not be null.

supplier - Supplier used to initialize the target on return.

Returns:

the existing target if not null, otherwise invoke the Supplier to supply a new instance of T.

invoke

public static <T> T invoke(java.lang.Object obj,
                           java.lang.String methodName)

Invokes a Method on an Object with the given name.

Type Parameters:

T - type of the Method return value.

Parameters:

obj - Object on which to invoke the Method.

methodName - String containing the name of the Method to invoke on Object.

Returns:

the return value of the invoked Method on Object.

Throws:

java.lang.IllegalArgumentException - if no Method with name could be found on Object.

See Also:

Method, Object

makeAccessible

public static java.lang.reflect.Constructor<?> makeAccessible(@NonNull
                                                              java.lang.reflect.Constructor<?> constructor)

Makes the Constructor accessible.

Parameters:

constructor - Constructor to make accessible; must not be null.

Returns:

the given Constructor.

See Also:

Constructor

makeAccessible

public static java.lang.reflect.Field makeAccessible(java.lang.reflect.Field field)

Makes the Field accessible.

Parameters:

field - Field to make accessible; must not be null.

Returns:

the given Field.

See Also:

Field

makeAccessible

public static java.lang.reflect.Method makeAccessible(java.lang.reflect.Method method)

Makes the Method accessible.

Parameters:

method - Method to make accessible; must not be null.

Returns:

the given Method.

See Also:

Method

returnValueThrowOnNull

public static <T> T returnValueThrowOnNull(T value)

Returns the given value or throws an IllegalArgumentException if value is null.

Type Parameters:

T - type of the value.

Parameters:

value - Object to return.

Returns:

the value or throw an IllegalArgumentException if value is null.

See Also:

returnValueThrowOnNull(Object, RuntimeException)

returnValueThrowOnNull

public static <T> T returnValueThrowOnNull(T value,
                                           java.lang.RuntimeException exception)

Returns the given value or throws the given RuntimeException if value is null.

Type Parameters:

T - type of the value.

Parameters:

value - Object to return.

exception - RuntimeException to throw if value is null.

Returns:

the value or throw the given RuntimeException if value is null.

resolveInvocationTarget

public static <T> T resolveInvocationTarget(T target,
                                            java.lang.reflect.Method method)

Resolves the invocation target for the given Method. If the Method is Modifier.STATIC then null is returned, otherwise target will be returned.

Type Parameters:

T - type of the target.

Parameters:

target - Object on which the Method will be invoked.

method - Method to invoke on the Object.

Returns:

the resolved invocation method.

See Also:

Object, Method