Package io.jans.orm.reflect.util

Class ReflectHelper

java.lang.Object

io.jans.orm.reflect.util.ReflectHelper

public final class ReflectHelper
extends Object

Utility class for various reflection operations.

Field Summary

Fields

Modifier and Type	Field	Description
static final Annotation[]	NO_ANNOTATIONS
static final Class<?>[]	NO_PARAM_SIGNATURE
static final Object[]	NO_PARAMS

Method Summary

Modifier and Type	Method	Description
static boolean	assignableFrom(Class<?> clazz, Class<?> intf)	Determine if the given class implements or extend the given class.
static Class<?>	classForName(String name)	Perform resolution of a class name.
static Class<?>	classForName(String name, Class<?> caller)	Perform resolution of a class name.
static void	copyObjectPropertyValues(Object fromEntry, Object toEntry, Getter[] propertyGetters, Setter[] propertySetters)
static Object	createArray(Class<?> clazz, int length)
static <T> T	createObjectByDefaultConstructor(Class<T> clazz)
static Method	extractEqualsMethod(Class<?> clazz)	Encapsulation of getting hold of a class's equals method.
static Method	extractHashCodeMethod(Class<?> clazz)	Encapsulation of getting hold of a class's hashCode method.
static Annotation	getAnnotationByType(Annotation[] annotations, Class<?> annotationType)
static Annotation	getAnnotationByType(List<Annotation> annotations, Class<?> annotationType)
static List<Annotation>	getClassAnnotations(Class<?> theClass, Class<?>... allowedAnnotations)
static Constructor<?>	getConstructor(Class<?> clazz, Class<?>... parameterTypes)	Retrieve a constructor for the given class, with arguments matching the specified Hibernate mapping.
static <T> Constructor<T>	getDefaultConstructor(Class<T> clazz)	Retrieve the default (no arg) constructor from the given class.
static Getter	getGetter(Class<?> theClass, String name)	Directly retrieve the Getter reference via the BasicPropertyAccessor.
static Class<?>	getListType(Getter getter)
static Class<?>	getListType(Setter setter)
static Method	getMethod(Class<?> clazz, Method method)
static Method	getMethod(Class<?> clazz, String methodName, Class<?>[] methodParams)
static Getter	getMethodOrPropertyGetter(Class<?> theClass, String name)
static Setter	getMethodOrPropertySetter(Class<?> theClass, String name)
static Map<String,List<Annotation>>	getPropertiesAnnotations(Class<?> theClass, Class<?>... allowedAnnotations)
static List<Annotation>	getPropertyAnnotations(Class<?> theClass, String propertyName, Class<?>... allowedAnnotations)
static String	getPropertyNameByType(Map<String,List<Annotation>> propertiesAnnotations, Class<?> annotationType)
static Object	getPropertyValue(Object entry, Getter[] propertyGetters)
static Setter	getSetter(Class<?> theClass, String name)	Directly retrieve the Setter reference via the BasicPropertyAccessor.
static Class<?>	getSetterType(Setter setter)
static Object	getValue(Object object, String name)
static boolean	isAbstractClass(Class<?> clazz)	Determine if the given class is declared abstract.
static boolean	isFinalClass(Class<?> clazz)	Determine is the given class is declared final.
static boolean	isNotPrimitiveClass(Class<?> theClass)
static boolean	isPublic(Class<?> clazz, Member member)	Is this member publicly accessible.
static boolean	isPublic(Member member)	Is this member publicly accessible.
static boolean	overridesEquals(Class<?> clazz)	Determine if the given class defines an Object.equals(java.lang.Object) override.
static boolean	overridesHashCode(Class<?> clazz)	Determine if the given class defines a Object.hashCode() override.
static Class<?>	reflectedPropertyClass(String className, String name)	Attempt to resolve the specified property type through reflection.
static void	sumObjectPropertyValues(Object resultEntry, Object entryToAdd, Getter[] propertyGetters, Setter[] propertySetters)

Methods inherited from class java.lang.Object

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

Field Details

NO_PARAM_SIGNATURE

public static final Class<?>[] NO_PARAM_SIGNATURE

NO_PARAMS

public static final Object[] NO_PARAMS

NO_ANNOTATIONS

public static final Annotation[] NO_ANNOTATIONS

Method Details

extractEqualsMethod

public static Method extractEqualsMethod(Class<?> clazz)
                                  throws NoSuchMethodException

Encapsulation of getting hold of a class's equals method.

Parameters:

clazz - The class from which to extract the equals method.

Returns:

The equals method reference

Throws:

NoSuchMethodException - Should indicate an attempt to extract equals method from interface.

extractHashCodeMethod

public static Method extractHashCodeMethod(Class<?> clazz)
                                    throws NoSuchMethodException

Encapsulation of getting hold of a class's hashCode method.

Parameters:

clazz - The class from which to extract the hashCode method.

Returns:

The hashCode method reference

Throws:

NoSuchMethodException - Should indicate an attempt to extract hashCode method from interface.

overridesEquals

public static boolean overridesEquals(Class<?> clazz)

Determine if the given class defines an Object.equals(java.lang.Object) override.

Parameters:

clazz - The class to check

Returns:

True if clazz defines an equals override.

overridesHashCode

public static boolean overridesHashCode(Class<?> clazz)

Determine if the given class defines a Object.hashCode() override.

Parameters:

clazz - The class to check

Returns:

True if clazz defines an hashCode override.

assignableFrom

public static boolean assignableFrom(Class<?> clazz,
 Class<?> intf)

Determine if the given class implements or extend the given class.

Parameters:

clazz - The class to check

intf - The interface to check it against.

Returns:

True if the class does implement the interface, false otherwise.

classForName

public static Class<?> classForName(String name,
 Class<?> caller)
                             throws ClassNotFoundException

Perform resolution of a class name.
Here we first check the context classloader, if one, before delegating to Class.forName(String, boolean, ClassLoader) using the caller's classloader

Parameters:

name - The class name

caller - The class from which this call originated (in order to access that class's loader).

Returns:

The class reference.

Throws:

ClassNotFoundException - From Class.forName(String, boolean, ClassLoader).

classForName

public static Class<?> classForName(String name)
                             throws ClassNotFoundException

Perform resolution of a class name.
Same as classForName(String, Class) except that here we delegate to Class.forName(String) if the context classloader lookup is unsuccessful.

Parameters:

name - The class name

Returns:

The class reference.

Throws:

ClassNotFoundException - From Class.forName(String).

isPublic

public static boolean isPublic(Member member)

Is this member publicly accessible.
Short-hand for isPublic(Class, Member) passing the member + Member.getDeclaringClass()

Parameters:

member - The member to check

Returns:

True if the member is publicly accessible.

isPublic

public static boolean isPublic(Class<?> clazz,
 Member member)

Is this member publicly accessible.

Parameters:

clazz - The class which defines the member

member - The memeber.

Returns:

True if the member is publicly accessible, false otherwise.

reflectedPropertyClass

public static Class<?> reflectedPropertyClass(String className,
 String name)
                                       throws MappingException

Attempt to resolve the specified property type through reflection.

Parameters:

className - The name of the class owning the property.

name - The name of the property.

Returns:

The type of the property.

Throws:

MappingException - Indicates we were unable to locate the property.

getGetter

public static Getter getGetter(Class<?> theClass,
 String name)
                        throws MappingException

Directly retrieve the Getter reference via the BasicPropertyAccessor.

Parameters:

theClass - The class owning the property

name - The name of the property

Returns:

The getter.

Throws:

MappingException - Indicates we were unable to locate the property.

getMethodOrPropertyGetter

public static Getter getMethodOrPropertyGetter(Class<?> theClass,
 String name)
                                        throws MappingException

Throws:

MappingException

getSetter

public static Setter getSetter(Class<?> theClass,
 String name)
                        throws MappingException

Directly retrieve the Setter reference via the BasicPropertyAccessor.

Parameters:

theClass - The class owning the property

name - The name of the property

Returns:

The setter.

Throws:

MappingException - Indicates we were unable to locate the property.

getMethodOrPropertySetter

public static Setter getMethodOrPropertySetter(Class<?> theClass,
 String name)
                                        throws MappingException

Throws:

MappingException

getDefaultConstructor

public static <T> Constructor<T> getDefaultConstructor(Class<T> clazz)
                                                throws PropertyNotFoundException

Retrieve the default (no arg) constructor from the given class.

Parameters:

clazz - The class for which to retrieve the default ctor.

Returns:

The default constructor.

Throws:

PropertyNotFoundException - Indicates there was not publicly accessible, no-arg constructor (todo : why PropertyNotFoundException???)

createObjectByDefaultConstructor

public static <T> T createObjectByDefaultConstructor(Class<T> clazz)
                                              throws PropertyNotFoundException,
IllegalArgumentException,
InstantiationException,
IllegalAccessException,
InvocationTargetException

Throws:

PropertyNotFoundException

IllegalArgumentException

InstantiationException

IllegalAccessException

InvocationTargetException

isAbstractClass

public static boolean isAbstractClass(Class<?> clazz)

Determine if the given class is declared abstract.

Parameters:

clazz - The class to check.

Returns:

True if the class is abstract, false otherwise.

isFinalClass

public static boolean isFinalClass(Class<?> clazz)

Determine is the given class is declared final.

Parameters:

clazz - The class to check.

Returns:

True if the class is final, flase otherwise.

getConstructor

public static Constructor<?> getConstructor(Class<?> clazz,
 Class<?>... parameterTypes)
                                     throws PropertyNotFoundException

Retrieve a constructor for the given class, with arguments matching the specified Hibernate mapping.

Parameters:

clazz - The class needing instantiation

parameterTypes - The types representing the required ctor param signature

Returns:

The matching constructor.

Throws:

PropertyNotFoundException - Indicates we could not locate an appropriate constructor (todo : again with PropertyNotFoundException???)

getMethod

public static Method getMethod(Class<?> clazz,
 Method method)

getAnnotationByType

public static Annotation getAnnotationByType(List<Annotation> annotations,
 Class<?> annotationType)

getAnnotationByType

public static Annotation getAnnotationByType(Annotation[] annotations,
 Class<?> annotationType)

getPropertyNameByType

public static String getPropertyNameByType(Map<String,List<Annotation>> propertiesAnnotations,
 Class<?> annotationType)

isNotPrimitiveClass

public static boolean isNotPrimitiveClass(Class<?> theClass)

getClassAnnotations

public static List<Annotation> getClassAnnotations(Class<?> theClass,
 Class<?>... allowedAnnotations)
                                            throws PropertyNotFoundException

Throws:

PropertyNotFoundException

getPropertyAnnotations

public static List<Annotation> getPropertyAnnotations(Class<?> theClass,
 String propertyName,
 Class<?>... allowedAnnotations)
                                               throws PropertyNotFoundException

Throws:

PropertyNotFoundException

getPropertiesAnnotations

public static Map<String,List<Annotation>> getPropertiesAnnotations(Class<?> theClass,
 Class<?>... allowedAnnotations)

getListType

public static Class<?> getListType(Getter getter)

getListType

public static Class<?> getListType(Setter setter)

getSetterType

public static Class<?> getSetterType(Setter setter)

getValue

public static Object getValue(Object object,
 String name)
                       throws MappingException

Throws:

MappingException

createArray

public static Object createArray(Class<?> clazz,
 int length)

getPropertyValue

public static Object getPropertyValue(Object entry,
 Getter[] propertyGetters)

copyObjectPropertyValues

public static void copyObjectPropertyValues(Object fromEntry,
 Object toEntry,
 Getter[] propertyGetters,
 Setter[] propertySetters)

sumObjectPropertyValues

public static void sumObjectPropertyValues(Object resultEntry,
 Object entryToAdd,
 Getter[] propertyGetters,
 Setter[] propertySetters)

getMethod

public static Method getMethod(Class<?> clazz,
 String methodName,
 Class<?>[] methodParams)
                        throws NoSuchMethodException

Throws:

NoSuchMethodException