org.jrebirth.af.core.util

Class ClassUtility

java.lang.Object

org.jrebirth.af.core.util.ClassUtility

All Implemented Interfaces:

MessageContainer, UtilMessages

public final class ClassUtility
extends Object
implements UtilMessages

The class ClassUtility. Some Useful class utilities to perform introspection.

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
private static String	CASE_SEPARATOR The separator use in upper case to simulate a acamleCase change.
private static JRLogger	LOGGER The class logger.
static String	SEPARATOR The separator used for serialization.

Fields inherited from interface org.jrebirth.af.core.util.UtilMessages

ARGUMENT_DETAIL, ARGUMENT_LIST, BAD_CANONICAL_PATH, BROKEN_API_NO_METHOD, BROKEN_API_WRONG_PARAMETERS, BROKEN_WAVE_BAD_ITEM_LIST, BROKEN_WAVE_SENT, CANT_READ_CACHED_JAR_FILE, FILE_UNREADABLE, GENERIC_TYPE_ERROR_1, GENERIC_TYPE_ERROR_2, NO_ANNOTATION_PROPERTY, NO_ANNOTATION_PROPERTY_VALUE, NO_CONSTRUCTOR, PARSE_CACHED_JAR_FILE, RESOURCE_IGNORED, USE_DEFAULT_CLASSLOADER, USE_JNLP_CLASSLOADER, WAVE_HANDLER_METHOD_REQUIRED

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ClassUtility() Private Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static Object	buildGenericType(Class<?> mainClass, Class<?>[] assignableClasses, Object... parameters) Build the nth generic type of a class.
static Object	buildGenericType(Class<?> mainClass, Class<?> assignableClass, Object... parameters) Build the nth generic type of a class.
static Object	callMethod(Method method, Object instance, Object... parameters) Call the given method for the instance object even if its visibility is private or protected.
static String	camelCaseToUnderscore(String camelCaseString) Convert aStringUnderscored into A_STRING_UNDESCORED.
static Class<?>	findGenericClass(Class<?> mainClass, Class<?> assignableClass) Return the generic class for the given parent class and index.
static Class<?>	findGenericClass(Class<?> mainClass, Class<?>[] excludedClasses) Return the generic class for the given parent class and index.
static Field	findProperty(Class<?> sourceClass, String itemName, Class<?> searchedClass) Retrieve a field according to the item name first, then according to searched class.
static List<Field>	getAnnotatedFields(Class<?> cls, Class<? extends Annotation> annotationClass) Retrieve all annotation of the given type from the given class.
static List<Method>	getAnnotatedMethods(Class<?> cls, Class<? extends Annotation> annotationClass) Retrieve all annotation of the given type from the given class.
static Object	getAnnotationAttribute(Annotation annotation, String attributeName) Retrieve an annotation property dynamically by reflection.
static Class<? extends Application>	getClassFromStaticMethod(int classDeepLevel) Return the class used by the Nth level of the current call stack.
static Class<?>	getClassFromType(Type type) Return the Class object for the given type.
private static Constructor<?>	getConstructor(Class<?> genericClass, Class<?>[] parameterTypes) Retrieve the constructor of a Type.
static <A extends Annotation> A	getLastClassAnnotation(Class<?> sourceClass, Class<A> annotationClass) Extract the last annotation requested found into the class hierarchy.
static Method	getMethodByName(Class<?> cls, String action) Return the method that exactly match the action name.
static List<Method>	retrieveMethodList(Class<?> cls, String methodName) Check if the given method exists in the given class.
static List<Field>	retrievePropertyList(Class<?> cls) List all properties for the given class.
static void	setFieldValue(Field field, Object instance, Object value) Update an object field even if it has a private or protected visibility.
static String	underscoreToCamelCase(String undescoredString) Convert A_STRING_UNDESCORED into aStringUnderscored.

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final String SEPARATOR

The separator used for serialization.

See Also:

Constant Field Values

CASE_SEPARATOR

private static final String CASE_SEPARATOR

The separator use in upper case to simulate a acamleCase change.

See Also:

Constant Field Values

LOGGER

private static final JRLogger LOGGER

The class logger.

Constructor Detail

ClassUtility

private ClassUtility()

Private Constructor.

Method Detail

buildGenericType

public static Object buildGenericType(Class<?> mainClass,
                      Class<?> assignableClass,
                      Object... parameters)
                               throws CoreException

Build the nth generic type of a class.

Parameters:

mainClass - The main class used (that contain at least one generic type)

assignableClass - the parent type of the generic to build

parameters - used by the constructor of the generic type

Returns:

a new instance of the generic type

Throws:

CoreException - if the instantiation fails

buildGenericType

public static Object buildGenericType(Class<?> mainClass,
                      Class<?>[] assignableClasses,
                      Object... parameters)
                               throws CoreException

Build the nth generic type of a class.

Parameters:

mainClass - The main class used (that contain at least one generic type)

assignableClasses - if the array contains only one class it define the type of the generic to build, otherwise it defines the types to skip to find the obejct to build

parameters - used by the constructor of the generic type

Returns:

a new instance of the generic type

Throws:

CoreException - if the instantiation fails

getConstructor

private static Constructor<?> getConstructor(Class<?> genericClass,
                            Class<?>[] parameterTypes)

Retrieve the constructor of a Type.

Parameters:

genericClass - the type of the object

parameterTypes - an array of parameters' type

Returns:

the right constructor that matchers parameters

findGenericClass

public static Class<?> findGenericClass(Class<?> mainClass,
                        Class<?> assignableClass)

Return the generic class for the given parent class and index.

Parameters:

mainClass - the parent class

assignableClass - the parent type of the generic to build

Returns:

the class of the generic type according to the index provided or null if not found

findGenericClass

public static Class<?> findGenericClass(Class<?> mainClass,
                        Class<?>[] excludedClasses)

Return the generic class for the given parent class and index.

Parameters:

mainClass - the parent class

excludedClasses - if the array contains only one class it define the type of the generic to build, otherwise it defines the types to skip to find the object to build

Returns:

the class of the generic type according to the index provided or null if not found

underscoreToCamelCase

public static String underscoreToCamelCase(String undescoredString)

Convert A_STRING_UNDESCORED into aStringUnderscored.

Parameters:

undescoredString - the string to convert

Returns:

the string with camelCase

camelCaseToUnderscore

public static String camelCaseToUnderscore(String camelCaseString)

Convert aStringUnderscored into A_STRING_UNDESCORED.

Parameters:

camelCaseString - the string to convert

Returns:

the underscored string

getMethodByName

public static Method getMethodByName(Class<?> cls,
                     String action)
                              throws NoSuchMethodException

Return the method that exactly match the action name. The name must be unique into the class.

Parameters:

cls - the class which contain the searched method

action - the name of the method to find

Returns:

the method

Throws:

NoSuchMethodException - if no method was method

retrievePropertyList

public static List<Field> retrievePropertyList(Class<?> cls)

List all properties for the given class.

Parameters:

cls - the class to inspect by reflection

Returns:

the field list

findProperty

public static Field findProperty(Class<?> sourceClass,
                 String itemName,
                 Class<?> searchedClass)

Retrieve a field according to the item name first, then according to searched class.

Parameters:

sourceClass - the class to inspect

itemName - the item name to find (LIKE_THIS)

searchedClass - the property class to find if item name query has failed

Returns:

the source class field that match provided criterion

retrieveMethodList

public static List<Method> retrieveMethodList(Class<?> cls,
                              String methodName)

Check if the given method exists in the given class.

Parameters:

cls - the class to search into

methodName - the name of the method to check (camelCased or in upper case with underscore separator)

Returns:

true if the method exists

getClassFromType

public static Class<?> getClassFromType(Type type)

Return the Class object for the given type.

Parameters:

type - the given type to cast into Class

Returns:

the Class casted object

getLastClassAnnotation

public static <A extends Annotation> A getLastClassAnnotation(Class<?> sourceClass,
                                              Class<A> annotationClass)

Extract the last annotation requested found into the class hierarchy.
Interfaces are not yet supported.

Type Parameters:

A - the type of the requested annotation

Parameters:

sourceClass - the class (wit its parent classes) to inspect

annotationClass - the annotation to find

Returns:

the request annotation or null if none have been found into the class hierarchy

getAnnotationAttribute

public static Object getAnnotationAttribute(Annotation annotation,
                            String attributeName)

Retrieve an annotation property dynamically by reflection.

Parameters:

annotation - the annotation to explore

attributeName - the name of the method to call

Returns:

the property value

getClassFromStaticMethod

public static Class<? extends Application> getClassFromStaticMethod(int classDeepLevel)

Return the class used by the Nth level of the current call stack.

Parameters:

classDeepLevel - the deep level to use to find the right class

Returns:

the Nth level ancestor class

getAnnotatedMethods

public static List<Method> getAnnotatedMethods(Class<?> cls,
                               Class<? extends Annotation> annotationClass)

Retrieve all annotation of the given type from the given class.

Parameters:

cls - the class that we want to inspect

annotationClass - the type of Annaotion to find

Returns:

the list of annotated method

getAnnotatedFields

public static List<Field> getAnnotatedFields(Class<?> cls,
                             Class<? extends Annotation> annotationClass)

Retrieve all annotation of the given type from the given class.

Parameters:

cls - the class that we want to inspect

annotationClass - the type of Annotation to find

Returns:

the list of annotated fields

callMethod

public static Object callMethod(Method method,
                Object instance,
                Object... parameters)
                         throws CoreException

Call the given method for the instance object even if its visibility is private or protected.

Parameters:

method - the method to call

instance - the object instance to use

parameters - the list of method parameters to use

Returns:

the method return

Throws:

CoreException - if the method call has failed

setFieldValue

public static void setFieldValue(Field field,
                 Object instance,
                 Object value)
                          throws CoreException

Update an object field even if it has a private or protected visibility.

Parameters:

field - the field to update

instance - the object instance that hold this field

value - the value to set into this field

Throws:

CoreException - if the new value cannot be set