jhelp.util.reflection

Class Reflector

java.lang.Object

jhelp.util.reflection.Reflector

public final class Reflector
extends java.lang.Object

Reflection utilities

Last modification : 6 mars 2009
Version 0.0.0

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PRIMITIVE_BOOLEAN Boolean primitive class name
static java.lang.String	PRIMITIVE_BYTE Byte primitive class name
static java.lang.String	PRIMITIVE_CHAR Char primitive class name
static java.lang.String	PRIMITIVE_DOUBLE Double primitive class name
static java.lang.String	PRIMITIVE_FLOAT Float primitive class name
static java.lang.String	PRIMITIVE_INT Int primitive class name
static java.lang.String	PRIMITIVE_LONG Long primitive class name
static java.lang.String	PRIMITIVE_SHORT Short primitive class name

Constructor Summary

Constructors

Constructor and Description
Reflector()

Method Summary

Methods

Modifier and Type	Method and Description
static void	forceChangeField(java.lang.Object object, java.lang.String fieldName, boolean newValue) Force change a boolean field value
static void	forceChangeField(java.lang.Object object, java.lang.String fieldName, java.lang.Object newValue) Force change a field value.
static java.lang.Object	forceGetField(java.lang.Object object, java.lang.String fieldName) Force to obtain a field value
static java.lang.Object	forceGetStaticField(java.lang.Class<?> claz, java.lang.String fieldName) Get a static field value
static void	forceInvokeMethod(java.lang.Object object, java.lang.String methodName, java.lang.Class<?>[] types, java.lang.Object[] values) Force invoke a method
static java.lang.Object	invokePublicMethod(java.lang.Class<?> clazz, java.lang.String methodName, java.lang.Object... parameters) Invoke a public method from a class.
static java.lang.Object	invokePublicMethod(java.lang.Object instance, java.lang.String methodName, java.lang.Object... parameters) Invoke a public method form a class represents by its instance.
static boolean	isInherit(java.lang.Class<?> test, java.lang.Class<?> parent) Indicates if a class extends an other one
static boolean	isSubTypeOf(java.lang.Class<?> testedClass, java.lang.Class<?> parentOrInterface) Indicates if a class extends or implements directly or not a class or a interface
static java.lang.Object	newInstance(java.lang.Class<?> type) Try create an instance of a class.
static java.lang.Object	newInstance(java.lang.String typeName) Try create an instance of a class.
static java.lang.Object	newInstance(java.lang.String typeName, java.lang.ClassLoader classLoader) Try create an instance of a class.
static java.lang.reflect.Field	obtainField(java.lang.Object object, java.lang.String fieldName) Obtain a field
static java.lang.reflect.Method	obtainPublicMethod(java.lang.Class<?> clazz, java.lang.String methodName, java.lang.Class<?>... types) Obtain public method from a class
static java.lang.Class<?>[]	obtainTypes(java.lang.Object... parameters) Extract all types of given parameters.
static boolean	typeMatch(java.lang.Class<?>[] types1, java.lang.Class<?>[] types2) Indicates if 2 arrays of types are similar.
static boolean	typeMatch(java.lang.Class<?> class1, java.lang.Class<?> class2) Indicates if 2 types are similar.

Methods inherited from class java.lang.Object

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

Field Detail

PRIMITIVE_BOOLEAN

public static final java.lang.String PRIMITIVE_BOOLEAN

Boolean primitive class name

See Also:

Constant Field Values

PRIMITIVE_BYTE

public static final java.lang.String PRIMITIVE_BYTE

Byte primitive class name

See Also:

Constant Field Values

PRIMITIVE_CHAR

public static final java.lang.String PRIMITIVE_CHAR

Char primitive class name

See Also:

Constant Field Values

PRIMITIVE_DOUBLE

public static final java.lang.String PRIMITIVE_DOUBLE

Double primitive class name

See Also:

Constant Field Values

PRIMITIVE_FLOAT

public static final java.lang.String PRIMITIVE_FLOAT

Float primitive class name

See Also:

Constant Field Values

PRIMITIVE_INT

public static final java.lang.String PRIMITIVE_INT

Int primitive class name

See Also:

Constant Field Values

PRIMITIVE_LONG

public static final java.lang.String PRIMITIVE_LONG

Long primitive class name

See Also:

Constant Field Values

PRIMITIVE_SHORT

public static final java.lang.String PRIMITIVE_SHORT

Short primitive class name

See Also:

Constant Field Values

Constructor Detail

Reflector

public Reflector()

Method Detail

forceChangeField

public static final void forceChangeField(java.lang.Object object,
                    java.lang.String fieldName,
                    boolean newValue)
                                   throws java.lang.NoSuchFieldException,
                                          java.lang.IllegalArgumentException,
                                          java.lang.IllegalAccessException

Force change a boolean field value

Parameters:

object - Object where lies the field

fieldName - Field name

newValue - New value

Throws:

java.lang.NoSuchFieldException - If field not exists

java.lang.IllegalArgumentException - If field isn't boolean

java.lang.IllegalAccessException - If force failed

forceChangeField

public static final void forceChangeField(java.lang.Object object,
                    java.lang.String fieldName,
                    java.lang.Object newValue)
                                   throws java.lang.NoSuchFieldException,
                                          java.lang.IllegalArgumentException,
                                          java.lang.IllegalAccessException

Force change a field value.

Parameters:

object - Object where lies the field

fieldName - Field name

newValue - New value

Throws:

java.lang.NoSuchFieldException - If field dosen't exists

java.lang.IllegalArgumentException - If value is not valid

java.lang.IllegalAccessException - If failed to change the field

forceGetField

public static final java.lang.Object forceGetField(java.lang.Object object,
                             java.lang.String fieldName)
                                            throws java.lang.NoSuchFieldException,
                                                   java.lang.IllegalArgumentException,
                                                   java.lang.IllegalAccessException

Force to obtain a field value

Parameters:

object - Object where lies the field

fieldName - Field name

Returns:

Field value

Throws:

java.lang.NoSuchFieldException - If field not exists

java.lang.IllegalArgumentException - Should never append

java.lang.IllegalAccessException - If access cant be force

forceGetStaticField

public static final java.lang.Object forceGetStaticField(java.lang.Class<?> claz,
                                   java.lang.String fieldName)
                                                  throws java.lang.NoSuchFieldException,
                                                         java.lang.IllegalArgumentException,
                                                         java.lang.IllegalAccessException

Get a static field value

Parameters:

claz - Class where lies the field

fieldName - Filed name

Returns:

Field value

Throws:

java.lang.NoSuchFieldException - If field not exists

java.lang.IllegalArgumentException - If field isn't static

java.lang.IllegalAccessException - If force failed

forceInvokeMethod

public static final void forceInvokeMethod(java.lang.Object object,
                     java.lang.String methodName,
                     java.lang.Class<?>[] types,
                     java.lang.Object[] values)
                                    throws java.lang.NoSuchMethodException,
                                           java.lang.IllegalArgumentException,
                                           java.lang.IllegalAccessException,
                                           java.lang.reflect.InvocationTargetException

Force invoke a method

Parameters:

object - Object where lies the method

methodName - Method name

types - Types of arguments

values - Parameters value

Throws:

java.lang.NoSuchMethodException - If method not exists

java.lang.IllegalArgumentException - If one of argument not valid

java.lang.IllegalAccessException - If force failed

java.lang.reflect.InvocationTargetException - If launch method failed

invokePublicMethod

public static final java.lang.Object invokePublicMethod(java.lang.Class<?> clazz,
                                  java.lang.String methodName,
                                  java.lang.Object... parameters)
                                                 throws java.lang.NoSuchMethodException,
                                                        java.lang.IllegalArgumentException,
                                                        java.lang.IllegalAccessException,
                                                        java.lang.reflect.InvocationTargetException

Invoke a public method from a class.
It is recommends to call static method with this, for non static, prefer use invokePublicMethod(Object, String, Object...)
If the method is non static, this method first try create an instance of the specified class with a "little" constructor, it use newInstance(Class) to do it.
NOTE :The method must be public, this method haven't rights to invoke other methods, so if not public, not found exception was throw

Parameters:

clazz - Class where the method lies

methodName - Method name to invoke

parameters - Methods parameters

Returns:

method result or null

Throws:

java.lang.NoSuchMethodException - If the given method is not public, or not exists with the parameters

java.lang.IllegalArgumentException - When invoke failed

java.lang.IllegalAccessException - When invoke failed

java.lang.reflect.InvocationTargetException - When invoke failed

invokePublicMethod

public static final java.lang.Object invokePublicMethod(java.lang.Object instance,
                                  java.lang.String methodName,
                                  java.lang.Object... parameters)
                                                 throws java.lang.NoSuchMethodException,
                                                        java.lang.IllegalArgumentException,
                                                        java.lang.IllegalAccessException,
                                                        java.lang.reflect.InvocationTargetException

Invoke a public method form a class represents by its instance.
We use this instance for invoke the method.
NOTE :The method must be public, this method haven't rights to invoke other methods, so if not public, not found exception was throw

Parameters:

instance - Instance of the class where method lies

methodName - Method name to invoke

parameters - Methods parameters

Returns:

method result

Throws:

java.lang.NoSuchMethodException - If the given method is not public, or not exists with the parameters

java.lang.IllegalArgumentException - When invoke failed

java.lang.IllegalAccessException - When invoke failed

java.lang.reflect.InvocationTargetException - When invoke failed

isInherit

public static final boolean isInherit(java.lang.Class<?> test,
                java.lang.Class<?> parent)

Indicates if a class extends an other one

Parameters:

test - Class to test

parent - Class to extends

Returns:

true if class extends an other one

isSubTypeOf

public static final boolean isSubTypeOf(java.lang.Class<?> testedClass,
                  java.lang.Class<?> parentOrInterface)

Indicates if a class extends or implements directly or not a class or a interface

Parameters:

testedClass - Class tested

parentOrInterface - Class or interface to extends or implements

Returns:

true if the class extends or implements directly or not the class or interface

newInstance

public static final java.lang.Object newInstance(java.lang.Class<?> type)

Try create an instance of a class.
It first look for "little" public constructor, that is to say a constructor with few parameters, if it founds default constructor without parameters, it use it.
If the constructor founds have parameters, it creates a instance of each parameters (on calling itself) an the use them for construct the instance.
BEWARE:

• In some case, it can falls in infinite loop
• It is not human, so can't read documentation and may use illegal argument for create the instance

Parameters:

type - Class type to create

Returns:

Created instance

newInstance

public static final java.lang.Object newInstance(java.lang.String typeName)
                                          throws java.lang.ClassNotFoundException

Try create an instance of a class.
It first look for "little" public constructor, that is to say a constructor with few parameters, if it founds default constructor without parameters, it use it.
If the constructor founds have parameters, it creates a instance of each parameters (on calling itself) an the use them for construct the instance.
BEWARE:

• In some case, it can falls in infinite loop
• It is not human, so can't read documentation and can use illegal argument for create the instance

Parameters:

typeName - Class name

Returns:

Instance created

Throws:

java.lang.ClassNotFoundException - If the class can't be resolve

newInstance

public static final java.lang.Object newInstance(java.lang.String typeName,
                           java.lang.ClassLoader classLoader)
                                          throws java.lang.ClassNotFoundException

Try create an instance of a class.
It first look for "little" public constructor, that is to say a constructor with few parameters, if it founds default constructor without parameters, it use it.
If the constructor founds have parameters, it creates a instance of each parameters (on calling itself) an the use them for construct the instance.
BEWARE:

• In some case, it can falls in infinite loop
• It is not human, so can't read documentation and can use illegal argument for create the instance

Parameters:

typeName - Type name

classLoader - Class loader to use

Returns:

Instance created

Throws:

java.lang.ClassNotFoundException - If the class can't be resolve

obtainField

public static final java.lang.reflect.Field obtainField(java.lang.Object object,
                                  java.lang.String fieldName)
                                                 throws java.lang.NoSuchFieldException,
                                                        java.lang.IllegalAccessException

Obtain a field

Parameters:

object - Object where lies the field

fieldName - Field name

Returns:

Filed

Throws:

java.lang.NoSuchFieldException - If field not exists

java.lang.IllegalAccessException - If force failed

obtainPublicMethod

public static final java.lang.reflect.Method obtainPublicMethod(java.lang.Class<?> clazz,
                                          java.lang.String methodName,
                                          java.lang.Class<?>... types)
                                                         throws java.lang.NoSuchMethodException

Obtain public method from a class

Parameters:

clazz - Class where method lies

methodName - Method name

types - Method parameters type

Returns:

The method

Throws:

java.lang.NoSuchMethodException - If the method not public or not exists with specified types

obtainTypes

public static final java.lang.Class<?>[] obtainTypes(java.lang.Object... parameters)

Extract all types of given parameters.
If the parameter is null, just null is return.
If some parameters are null, the corresponding type was also null

Parameters:

parameters - Parameters to extract is types

Returns:

Extracted types.

typeMatch

public static final boolean typeMatch(java.lang.Class<?> class1,
                java.lang.Class<?> class2)

Indicates if 2 types are similar.
null is accepted for parameters

Parameters:

class1 - First type

class2 - Second type

Returns:

true if types are similar

typeMatch

public static final boolean typeMatch(java.lang.Class<?>[] types1,
                java.lang.Class<?>[] types2)

Indicates if 2 arrays of types are similar.
Array says similar if they have same length and each type of arrays are one to one similar
null are consider like zero length array
Each array can contains null elements.
For the compare 2 types, it use typeMatch(Class, Class)

Parameters:

types1 - First array

types2 - Second array

Returns:

true if arrays are similar