com.shocknode.utilities.reflection

Class Reflection

java.lang.Object

com.shocknode.utilities.reflection.Reflection

public class Reflection
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Reflection()

Method Summary

Modifier and Type	Method and Description
static <T> T	get(java.lang.Object object, java.lang.String name, java.lang.Class<T> typeClass) returns object of provided class type
static <T> java.lang.reflect.Constructor<T>	getConstructor(java.lang.Class<T> clazz, java.lang.Class<?>... parameters) returns the constructor of the provided class
static java.lang.reflect.Field	getField(java.lang.Object object, java.lang.String name) returns the field of the provided object
static java.util.List<java.lang.reflect.Constructor>	getHierarchyConstructors(java.lang.Class<?> start) returns a list of constructors found up the start class hierarchy
static java.util.List<java.lang.reflect.Constructor>	getHierarchyConstructors(java.lang.Class<?> start, java.lang.Class<?> end) returns a list of constructors found up the start class hierarchy until the end class is reached
static java.util.List<java.lang.reflect.Constructor>	getHierarchyConstructors(java.lang.Object start) returns a list of constructors found up the start object's class hierarchy
static java.util.List<java.lang.reflect.Constructor>	getHierarchyConstructors(java.lang.Object start, java.lang.Class<?> end) returns a list of constructors found up the start object's class hierarchy until the end class is reached
static <T> java.util.List<java.util.List<T>>	getHierarchyFieldListsOfClassType(java.lang.Object object, java.lang.Class<T> typeClass) returns a list of list of provided class type from heirarchy fields
static java.util.List<java.lang.reflect.Field>	getHierarchyFields(java.lang.Class<?> start) returns a list of fields found up the class hierarchy
static java.util.List<java.lang.reflect.Field>	getHierarchyFields(java.lang.Class<?> start, java.lang.Class<?> end) returns a list of fields found up the class hierarchy until end class is reached
static java.util.List<java.lang.reflect.Field>	getHierarchyFields(java.lang.Object start) returns a list of fields found up the object's class hierarchy
static java.util.List<java.lang.reflect.Field>	getHierarchyFields(java.lang.Object start, java.lang.Class<?> end) returns a list of fields found up the start object's class hierarchy until the end class is reached
static <T> java.util.List<T>	getHierarchyFieldValuesOfClassType(java.lang.Object object, java.lang.Class<T> typeClass) returns a list of field values by provided class type
static java.util.List<java.lang.reflect.Method>	getHierarchyMethods(java.lang.Class<?> start) returns a list of methods found up the start class hierarchy
static java.util.List<java.lang.reflect.Method>	getHierarchyMethods(java.lang.Class<?> start, java.lang.Class<?> end) returns a list of methods found up the start class hierarchy until end class is reached
static java.util.List<java.lang.reflect.Method>	getHierarchyMethods(java.lang.Object start) returns a list of methods found up the start object's class hierarchy
static java.util.List<java.lang.reflect.Method>	getHierarchyMethods(java.lang.Object start, java.lang.Class<?> end) returns a list of methods found up the start object's class hierarchy until the end class is reached
static <T> java.util.List<T>	getList(java.lang.Object object, java.lang.String name, java.lang.Class<T> listTypeClass) returns a list of provided class type
static java.lang.Class<?>	getListClass(java.lang.Object object, java.lang.String name) returns the class of list field
static java.lang.reflect.Method	getMethod(java.lang.Class<?> clazz, java.lang.String name, java.lang.Class<?>... parameters) returns the method of the provided class
static java.lang.String	getName(java.lang.reflect.Field field) returns the name of the provided field object
static java.lang.String	getType(java.lang.reflect.Field field) returns the type string of the provided field object
static java.lang.String	getType(java.lang.Object value) returns the type string of the provided object
static <T> T	instanceOf(java.lang.Class<T> objectClass, Parameter... parameters) returns an instance of the class type provided
static boolean	isInstanceOf(java.lang.Class<?> clazz, java.lang.Class<?>... classes) returns true if object is an instance of all provided classes, else false
static <T> boolean	isInstanceOf(T object, java.lang.Class<?>... classes) returns true if object is an instance of all provided classes, else false
static boolean	isInstanceOfAny(java.lang.Class<?> clazz, java.lang.Class<?>... classes) returns true if object is an instance of any provided classes, else false
static <T> boolean	isInstanceOfAny(T object, java.lang.Class<?>... classes) returns true if object is an instance of any provided classes, else false
static boolean	isType(java.lang.reflect.Field field, java.lang.String... types) returns true if field type matches all provided type strings, else false
static boolean	isTypeOfAny(java.lang.reflect.Field field, java.lang.String... types) returns true if field type matches any provided type strings, else false
static java.lang.Object	run(java.lang.Object object, java.lang.String name, Parameter... parameters) returns the specified method of the provided object with the provided parameter
static <T> T	runGetter(java.lang.Object object, java.lang.String fieldName, java.lang.Class<T> fieldClass) runs getter method for a specified field name
static void	runSetter(java.lang.Object object, java.lang.String fieldName, java.lang.Object value) runs setter method for the provided field name with the provided value
static void	runSetter(java.lang.Object object, java.lang.String fieldName, Parameter<?> parameter) runs setter method for the provided field name with the provided parameter

Methods inherited from class java.lang.Object

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

Constructor Detail

Reflection

public Reflection()

Method Detail

runGetter

public static <T> T runGetter(java.lang.Object object,
                              java.lang.String fieldName,
                              java.lang.Class<T> fieldClass)
                       throws java.lang.IllegalAccessException,
                              java.lang.reflect.InvocationTargetException,
                              NullNotSupportedException,
                              java.lang.NoSuchFieldException,
                              java.lang.NoSuchMethodException

runs getter method for a specified field name

Parameters:

object - object to run getter method on

fieldName - name of the field to run getter method on

fieldClass - class type of the value returned from the function

Returns:

value of class type provided as the last parameter of the function

Throws:

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

NullNotSupportedException

java.lang.NoSuchFieldException

java.lang.NoSuchMethodException

instanceOf

public static <T> T instanceOf(java.lang.Class<T> objectClass,
                               Parameter... parameters)
                        throws java.lang.InstantiationException,
                               java.lang.IllegalAccessException,
                               java.lang.reflect.InvocationTargetException,
                               NullNotSupportedException

returns an instance of the class type provided

Parameters:

objectClass - class type to return instance of

parameters - map of field class type and value representing a parameter

Returns:

instance of class type provided as the first parameter of the function

Throws:

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

NullNotSupportedException

isInstanceOf

public static <T> boolean isInstanceOf(T object,
                                       java.lang.Class<?>... classes)

returns true if object is an instance of all provided classes, else false

Parameters:

object - object to run instance check on

classes - list of classes to check object against

Returns:

true if object is an instance of all provided classes, else false

isInstanceOf

public static boolean isInstanceOf(java.lang.Class<?> clazz,
                                   java.lang.Class<?>... classes)

returns true if object is an instance of all provided classes, else false

Parameters:

clazz - class to run instance check on

classes - list of classes to check object against

Returns:

true if object is an instance of all provided classes, else false

isInstanceOfAny

public static <T> boolean isInstanceOfAny(T object,
                                          java.lang.Class<?>... classes)

returns true if object is an instance of any provided classes, else false

Parameters:

object - object to run instance check on

classes - list of classes to check object against

Returns:

true if object is an instance of any provided classes, else false

isInstanceOfAny

public static boolean isInstanceOfAny(java.lang.Class<?> clazz,
                                      java.lang.Class<?>... classes)

returns true if object is an instance of any provided classes, else false

Parameters:

clazz - class to run instance check on

classes - list of classes to check object against

Returns:

true if object is an instance of any provided classes, else false

run

public static java.lang.Object run(java.lang.Object object,
                                   java.lang.String name,
                                   Parameter... parameters)
                            throws java.lang.Exception

returns the specified method of the provided object with the provided parameter

Parameters:

object - object to run getter method on

parameters - map of field class type and value representing a parameter

Returns:

instance of class type provided as the first parameter of the function

Throws:

java.lang.Exception

runSetter

public static void runSetter(java.lang.Object object,
                             java.lang.String fieldName,
                             Parameter<?> parameter)
                      throws NullNotSupportedException,
                             java.lang.NoSuchMethodException,
                             java.lang.IllegalAccessException,
                             java.lang.reflect.InvocationTargetException

runs setter method for the provided field name with the provided parameter

Parameters:

object - object to run setter method on

fieldName - name of the field to run setter method on

parameter - parameter to provide to the setter method

Throws:

NullNotSupportedException

java.lang.NoSuchMethodException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

See Also:

Parameter

runSetter

public static void runSetter(java.lang.Object object,
                             java.lang.String fieldName,
                             java.lang.Object value)
                      throws NullNotSupportedException,
                             java.lang.NoSuchMethodException,
                             java.lang.IllegalAccessException,
                             java.lang.reflect.InvocationTargetException

runs setter method for the provided field name with the provided value

Parameters:

object - object to run setter method on

fieldName - name of the field to run setter method on

value - value to provide to the setter method

Throws:

NullNotSupportedException

java.lang.NoSuchMethodException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

isTypeOfAny

public static boolean isTypeOfAny(java.lang.reflect.Field field,
                                  java.lang.String... types)

returns true if field type matches any provided type strings, else false

Parameters:

field - field to run type check on

types - list of type strings to check field against

Returns:

true if field type matches any provided type strings, else false

isType

public static boolean isType(java.lang.reflect.Field field,
                             java.lang.String... types)

returns true if field type matches all provided type strings, else false

Parameters:

field - field to run type check on

types - list of type strings to check field against

Returns:

true if field type matches all provided type strings, else false

getName

public static java.lang.String getName(java.lang.reflect.Field field)

returns the name of the provided field object

Parameters:

field - field to return name from

Returns:

the name of the provided field object

getType

public static java.lang.String getType(java.lang.reflect.Field field)

returns the type string of the provided field object

Parameters:

field - field to return name from

Returns:

the type string of the provided field object

getType

public static java.lang.String getType(java.lang.Object value)

returns the type string of the provided object

Parameters:

value - object to return name from

Returns:

the type string of the provided object

getField

public static java.lang.reflect.Field getField(java.lang.Object object,
                                               java.lang.String name)
                                        throws NullNotSupportedException,
                                               java.lang.NoSuchFieldException

returns the field of the provided object

Parameters:

object - object to return field from

name - name of the field to return

Returns:

field found by provided name

Throws:

NullNotSupportedException

java.lang.NoSuchFieldException

getMethod

public static java.lang.reflect.Method getMethod(java.lang.Class<?> clazz,
                                                 java.lang.String name,
                                                 java.lang.Class<?>... parameters)
                                          throws NullNotSupportedException,
                                                 java.lang.NoSuchMethodException

returns the method of the provided class

Parameters:

clazz - class that contains the method

name - name of method to return

parameters - array of classes representing method parameters

Returns:

method found by provided name and parameter classes

Throws:

NullNotSupportedException

java.lang.NoSuchMethodException

getConstructor

public static <T> java.lang.reflect.Constructor<T> getConstructor(java.lang.Class<T> clazz,
                                                                  java.lang.Class<?>... parameters)

returns the constructor of the provided class

Parameters:

clazz - class to return constructor from

parameters - array of classes representing parameters

Returns:

constructor found by provided name and parameter classes

getHierarchyFields

public static java.util.List<java.lang.reflect.Field> getHierarchyFields(java.lang.Class<?> start,
                                                                         java.lang.Class<?> end)

returns a list of fields found up the class hierarchy until end class is reached

Parameters:

start - class to start collecting fields from

end - last class to collecting fields from

Returns:

list of fields found up the class hierarchy until end class is reached

getHierarchyFields

public static java.util.List<java.lang.reflect.Field> getHierarchyFields(java.lang.Class<?> start)

returns a list of fields found up the class hierarchy

Parameters:

start - class to start collecting fields from

Returns:

list of fields found

getHierarchyFields

public static java.util.List<java.lang.reflect.Field> getHierarchyFields(java.lang.Object start)

returns a list of fields found up the object's class hierarchy

Parameters:

start - object to start collecting fields from

Returns:

list of fields found

getHierarchyFields

public static java.util.List<java.lang.reflect.Field> getHierarchyFields(java.lang.Object start,
                                                                         java.lang.Class<?> end)

returns a list of fields found up the start object's class hierarchy until the end class is reached

Parameters:

start - class to start collecting fields from

end - last class to collecting fields from

Returns:

list of fields found up the object's class hierarchy until end class is reached

getHierarchyMethods

public static java.util.List<java.lang.reflect.Method> getHierarchyMethods(java.lang.Class<?> start,
                                                                           java.lang.Class<?> end)

returns a list of methods found up the start class hierarchy until end class is reached

Parameters:

start - class to start collecting methods from

end - last class to collecting methods from

Returns:

list of methods found up the class hierarchy until end class is reached

getHierarchyMethods

public static java.util.List<java.lang.reflect.Method> getHierarchyMethods(java.lang.Class<?> start)

returns a list of methods found up the start class hierarchy

Parameters:

start - class to start collecting methods from

Returns:

list of methods found up the class hierarchy

getHierarchyMethods

public static java.util.List<java.lang.reflect.Method> getHierarchyMethods(java.lang.Object start)

returns a list of methods found up the start object's class hierarchy

Parameters:

start - object to start collecting methods from

Returns:

list of methods found up the object's class hierarchy

getHierarchyMethods

public static java.util.List<java.lang.reflect.Method> getHierarchyMethods(java.lang.Object start,
                                                                           java.lang.Class<?> end)

returns a list of methods found up the start object's class hierarchy until the end class is reached

Parameters:

start - object to start collecting methods from

end - class to end collection of methods after

Returns:

list of methods found up the start object's class hierarchy until the end class is reached

getHierarchyConstructors

public static java.util.List<java.lang.reflect.Constructor> getHierarchyConstructors(java.lang.Class<?> start,
                                                                                     java.lang.Class<?> end)

returns a list of constructors found up the start class hierarchy until the end class is reached

Parameters:

start - class to start collecting constructors from

end - class to end collection of methods after

Returns:

list of constructors found up the start class hierarchy until the end class is reached

getHierarchyConstructors

public static java.util.List<java.lang.reflect.Constructor> getHierarchyConstructors(java.lang.Class<?> start)

returns a list of constructors found up the start class hierarchy

Parameters:

start - class to start collecting constructors from

Returns:

list of constructors found up the start class hierarchy

getHierarchyConstructors

public static java.util.List<java.lang.reflect.Constructor> getHierarchyConstructors(java.lang.Object start)

returns a list of constructors found up the start object's class hierarchy

Parameters:

start - object to start collecting constructors from

Returns:

list of constructors found up the start object's class hierarchy

getHierarchyConstructors

public static java.util.List<java.lang.reflect.Constructor> getHierarchyConstructors(java.lang.Object start,
                                                                                     java.lang.Class<?> end)

returns a list of constructors found up the start object's class hierarchy until the end class is reached

Parameters:

start - object to start collecting constructors from

end - class to end collection of methods after

Returns:

list of constructors found up the start object's class hierarchy until the end class is reached

getListClass

public static java.lang.Class<?> getListClass(java.lang.Object object,
                                              java.lang.String name)
                                       throws java.lang.Exception

returns the class of list field

Parameters:

object - object to retrieve list from

name - name of list field

Returns:

class of list field

Throws:

java.lang.Exception

getList

public static <T> java.util.List<T> getList(java.lang.Object object,
                                            java.lang.String name,
                                            java.lang.Class<T> listTypeClass)
                                     throws java.lang.Exception

returns a list of provided class type

Parameters:

object - object to retrieve list from

name - name of list field

listTypeClass - class type of list to return

Returns:

list of provided class type

Throws:

java.lang.Exception

get

public static <T> T get(java.lang.Object object,
                        java.lang.String name,
                        java.lang.Class<T> typeClass)
                 throws java.lang.Exception

returns object of provided class type

Parameters:

object - object to retrieve field value from

name - name of list field

typeClass - class type of field value to return

Returns:

object of provided class type

Throws:

java.lang.Exception

getHierarchyFieldListsOfClassType

public static <T> java.util.List<java.util.List<T>> getHierarchyFieldListsOfClassType(java.lang.Object object,
                                                                                      java.lang.Class<T> typeClass)
                                                                               throws java.lang.Exception

returns a list of list of provided class type from heirarchy fields

Parameters:

object - object to retrieve field values from

typeClass - class type of list to return

Returns:

list of list of provided class type

Throws:

java.lang.Exception

getHierarchyFieldValuesOfClassType

public static <T> java.util.List<T> getHierarchyFieldValuesOfClassType(java.lang.Object object,
                                                                       java.lang.Class<T> typeClass)
                                                                throws java.lang.Exception

returns a list of field values by provided class type

Parameters:

object - object to retrieve field values from

typeClass - class type of list to return

Returns:

list of provided class type

Throws:

java.lang.Exception