org.key_project.util.java

Class ObjectUtil

java.lang.Object

org.key_project.util.java.ObjectUtil

public final class ObjectUtil
extends Object

Provides static methods to work with objects.

Author:

Martin Hentschel

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ObjectUtil() Forbid instances by this private constructor.

Method Summary

Modifier and Type	Method and Description
static <T> Comparator<T>	createEqualsComparator() Creates a Comparator that can be used to compute the equality of two given Objects.
static boolean	equals(Object first, Object second) Nullpointer save execution of Object.equals(Object).
static Field	findField(Class<?> classInstance, String fieldName) Finds the Field with the name inside the given Class.
static Method	findMethod(Class<?> classInstance, String methodName, Class... parameterClasses) Finds the Method in the given Class.
static <T> T	get(Object obj, Class<?> classInstance, String fieldName) Returns the value from the field.
static <T> T	get(Object obj, Field field) Returns the value from the field.
static <T> T	get(Object obj, String fieldName) Returns the value from the field.
static Class<?>	getClass(Object obj) Nullpointer save execution of Object.getClass().
static int	hashCode(Object obj) Nullpointer save execution of Object.hashCode()
static <T> T	invoke(Object obj, Method method, Object... parameters) Executes the method on the given Object.
static <T> T	invoke(Object obj, String methodName, Object... parameters) Executes the method on the given Object.
static void	set(Object obj, Class<?> classInstance, String fieldName, boolean value) Sets the value of the given field on the given Object.
static void	set(Object obj, Class<?> classInstance, String fieldName, int value) Sets the value of the given field on the given Object.
static void	set(Object obj, Class<?> classInstance, String fieldName, Object value) Sets the value of the given field on the given Object.
static void	set(Object obj, Field field, boolean value) Sets the value of the given field on the given Object.
static void	set(Object obj, Field field, int value) Sets the value of the given field on the given Object.
static void	set(Object obj, Field field, Object value) Sets the value of the given field on the given Object.
static void	set(Object obj, String fieldName, boolean value) Sets the value of the given field on the given Object.
static void	set(Object obj, String fieldName, int value) Sets the value of the given field on the given Object.
static void	set(Object obj, String fieldName, Object value) Sets the value of the given field on the given Object.
static void	sleep(int time) Sleeps the current Thread for the given time.
static String	toString(Object obj) Nullpointer save execution of Object.toString().
static void	waitForThreads(Thread[] threads) Waits until the given Threads have terminated.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectUtil

private ObjectUtil()

Forbid instances by this private constructor.

Method Detail

get

public static <T> T get(Object obj,
                        String fieldName)
                 throws SecurityException,
                        NoSuchFieldException,
                        IllegalArgumentException,
                        IllegalAccessException

Returns the value from the field.

Type Parameters:

T - The value type.

Parameters:

obj - The object to read from.

fieldName - The name of the field.

Returns:

The field value.

Throws:

SecurityException - Occurred Exception.

NoSuchFieldException - Occurred Exception.

IllegalArgumentException - Occurred Exception.

IllegalAccessException - Occurred Exception.

get

public static <T> T get(Object obj,
                        Class<?> classInstance,
                        String fieldName)
                 throws SecurityException,
                        NoSuchFieldException,
                        IllegalArgumentException,
                        IllegalAccessException

Returns the value from the field.

Type Parameters:

T - The value type.

Parameters:

obj - The object to read from.

classInstance - The class in that the field is declared.

fieldName - The name of the field.

Returns:

The field value.

Throws:

SecurityException - Occurred Exception.

NoSuchFieldException - Occurred Exception.

IllegalArgumentException - Occurred Exception.

IllegalAccessException - Occurred Exception.

get

public static <T> T get(Object obj,
                        Field field)
                 throws IllegalArgumentException,
                        IllegalAccessException

Returns the value from the field.

Type Parameters:

T - The value type.

Parameters:

obj - The object to read from.

field - The Field to read.

Returns:

The field value.

Throws:

IllegalArgumentException - Occurred Exception.

IllegalAccessException - Occurred Exception.

set

public static void set(Object obj,
                       String fieldName,
                       Object value)
                throws SecurityException,
                       NoSuchFieldException,
                       IllegalArgumentException,
                       IllegalAccessException

Sets the value of the given field on the given Object.

Parameters:

obj - The object to write to.

fieldName - The name of the field.

value - The value to write.

Throws:

SecurityException - Occurred Exception.

NoSuchFieldException - Occurred Exception.

IllegalArgumentException - Occurred Exception.

IllegalAccessException - Occurred Exception.

set

public static void set(Object obj,
                       Class<?> classInstance,
                       String fieldName,
                       Object value)
                throws SecurityException,
                       NoSuchFieldException,
                       IllegalArgumentException,
                       IllegalAccessException

Sets the value of the given field on the given Object.

Parameters:

obj - The object to write to.

classInstance - The class in that the field is declared.

fieldName - The name of the field.

value - The value to write.

Throws:

SecurityException - Occurred Exception.

NoSuchFieldException - Occurred Exception.

IllegalArgumentException - Occurred Exception.

IllegalAccessException - Occurred Exception.

set

public static void set(Object obj,
                       Field field,
                       Object value)
                throws IllegalArgumentException,
                       IllegalAccessException

Sets the value of the given field on the given Object.

Parameters:

obj - The object to write to.

field - The Field to write to.

value - The value to write.

Throws:

IllegalArgumentException - Occurred Exception.

IllegalAccessException - Occurred Exception.

set

public static void set(Object obj,
                       String fieldName,
                       boolean value)
                throws SecurityException,
                       NoSuchFieldException,
                       IllegalArgumentException,
                       IllegalAccessException

Sets the value of the given field on the given Object.

Parameters:

obj - The object to write to.

fieldName - The name of the field.

value - The value to write.

Throws:

SecurityException - Occurred Exception.

NoSuchFieldException - Occurred Exception.

IllegalArgumentException - Occurred Exception.

IllegalAccessException - Occurred Exception.

set

public static void set(Object obj,
                       Class<?> classInstance,
                       String fieldName,
                       boolean value)
                throws SecurityException,
                       NoSuchFieldException,
                       IllegalArgumentException,
                       IllegalAccessException

Sets the value of the given field on the given Object.

Parameters:

obj - The object to write to.

classInstance - The class in that the field is declared.

fieldName - The name of the field.

value - The value to write.

Throws:

SecurityException - Occurred Exception.

NoSuchFieldException - Occurred Exception.

IllegalArgumentException - Occurred Exception.

IllegalAccessException - Occurred Exception.

set

public static void set(Object obj,
                       Field field,
                       boolean value)
                throws IllegalArgumentException,
                       IllegalAccessException

Sets the value of the given field on the given Object.

Parameters:

obj - The object to write to.

field - The Field to write to.

value - The value to write.

Throws:

IllegalArgumentException - Occurred Exception.

IllegalAccessException - Occurred Exception.

set

public static void set(Object obj,
                       String fieldName,
                       int value)
                throws SecurityException,
                       NoSuchFieldException,
                       IllegalArgumentException,
                       IllegalAccessException

Sets the value of the given field on the given Object.

Parameters:

obj - The object to write to.

fieldName - The name of the field.

value - The value to write.

Throws:

SecurityException - Occurred Exception.

NoSuchFieldException - Occurred Exception.

IllegalArgumentException - Occurred Exception.

IllegalAccessException - Occurred Exception.

set

public static void set(Object obj,
                       Class<?> classInstance,
                       String fieldName,
                       int value)
                throws SecurityException,
                       NoSuchFieldException,
                       IllegalArgumentException,
                       IllegalAccessException

Sets the value of the given field on the given Object.

Parameters:

obj - The object to write to.

classInstance - The class in that the field is declared.

fieldName - The name of the field.

value - The value to write.

Throws:

SecurityException - Occurred Exception.

NoSuchFieldException - Occurred Exception.

IllegalArgumentException - Occurred Exception.

IllegalAccessException - Occurred Exception.

set

public static void set(Object obj,
                       Field field,
                       int value)
                throws IllegalArgumentException,
                       IllegalAccessException

Sets the value of the given field on the given Object.

Parameters:

obj - The object to write to.

field - The Field to write to.

value - The value to write.

Throws:

IllegalArgumentException - Occurred Exception.

IllegalAccessException - Occurred Exception.

findField

public static Field findField(Class<?> classInstance,
                              String fieldName)
                       throws SecurityException,
                              NoSuchFieldException

Finds the Field with the name inside the given Class.

Parameters:

classInstance - The Class to search in.

fieldName - The name of the field.

Returns:

The found Field.

Throws:

SecurityException - Occurred Exception.

NoSuchFieldException - Occurred Exception.

invoke

public static <T> T invoke(Object obj,
                           String methodName,
                           Object... parameters)
                    throws NoSuchMethodException,
                           IllegalArgumentException,
                           IllegalAccessException,
                           InvocationTargetException

Executes the method on the given Object.

Type Parameters:

T - The return type

Parameters:

obj - The Object to execute on.

methodName -

parameters - The method parameters.

Returns:

The method result.

Throws:

NoSuchMethodException - Occurred Exception.

IllegalArgumentException - Occurred Exception.

IllegalAccessException - Occurred Exception.

InvocationTargetException - Occurred Exception.

invoke

public static <T> T invoke(Object obj,
                           Method method,
                           Object... parameters)
                    throws IllegalArgumentException,
                           IllegalAccessException,
                           InvocationTargetException

Executes the method on the given Object.

Type Parameters:

T - The return type

Parameters:

obj - The Object to execute on.

method - The Method to execute.

parameters - The method parameters.

Returns:

The method result.

Throws:

IllegalArgumentException - Occurred Exception.

IllegalAccessException - Occurred Exception.

InvocationTargetException - Occurred Exception.

findMethod

public static Method findMethod(Class<?> classInstance,
                                String methodName,
                                Class... parameterClasses)
                         throws NoSuchMethodException

Finds the Method in the given Class.

Parameters:

classInstance - The Class to search in.

methodName - The method name to search.

parameterClasses - The parameter Classes.

Returns:

The found Method.

Throws:

NoSuchMethodException - Occurred Exception

equals

public static boolean equals(Object first,
                             Object second)

Nullpointer save execution of Object.equals(Object). The two objects are also equal if both references are null

Parameters:

first - The first Object.

second - The second Object.

Returns:

true objects are equal or both null, false otherwise

toString

public static String toString(Object obj)

Nullpointer save execution of Object.toString().

Parameters:

obj - The object to execute to string on.

Returns:

The string value or null if the object is null.

hashCode

public static int hashCode(Object obj)

Nullpointer save execution of Object.hashCode()

Parameters:

obj - The object to get the hashcode from.

Returns:

The hashcode that is might 0 if the object was null.

createEqualsComparator

public static <T> Comparator<T> createEqualsComparator()

Creates a Comparator that can be used to compute the equality of two given Objects. They are seen as equal if equals(Object, Object) tells it. In this case 0 is returned in Comparator.compare(Object, Object). If they are not equal Comparator.compare(Object, Object) returns a value different to 0.

Returns:

The created Comparator.

getClass

public static Class<?> getClass(Object obj)

Nullpointer save execution of Object.getClass().

Parameters:

obj - The object to execute get class on.

Returns:

The Class or null if the object is null.

waitForThreads

public static void waitForThreads(Thread[] threads)

Waits until the given Threads have terminated.

Parameters:

threads - The Threads to wait for.

sleep

public static void sleep(int time)

Sleeps the current Thread for the given time.

Parameters:

time - The time to sleep.