org.hibernate.internal.util

Class ReflectHelper

java.lang.Object

org.hibernate.internal.util.ReflectHelper

public final class ReflectHelper
extends Object

Utility class for various reflection operations.

Author:

Gavin King, Steve Ebersole, Chris Cranford

Field Summary

Fields

Modifier and Type	Field and Description
static Class[]	NO_PARAM_SIGNATURE
static Object[]	NO_PARAMS
static Class[]	SINGLE_OBJECT_PARAM_SIGNATURE

Method Summary

Modifier and Type	Method and Description
static Class	classForName(String name) Deprecated. Depending on context, either ClassLoaderService or ClassLoaderAccess should be preferred
static Class	classForName(String name, Class caller) Perform resolution of a class name.
static void	ensureAccessibility(AccessibleObject accessibleObject)
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 Field	findField(Class containerClass, String propertyName)
static Method	findGetterMethod(Class containerClass, String propertyName)
static Method	findGetterMethodForFieldAccess(Field field, String propertyName) Similar to getterMethodOrNull(java.lang.Class, java.lang.String), except that here we are just looking for the corresponding getter for a field (defined as field access) if one exists.
static Method	findSetterMethod(Class containerClass, String propertyName, Class propertyType)
static Object	getConstantValue(String name, SessionFactoryImplementor factory)
static Constructor	getConstructor(Class clazz, Type[] types) Retrieve a constructor for the given class, with arguments matching the specified Hibernate mapping types.
static <T> Constructor<T>	getDefaultConstructor(Class<T> clazz) Retrieve the default (no arg) constructor from the given class.
static Method	getMethod(Class clazz, Method method)
static Method	getterMethodOrNull(Class containerJavaType, String propertyName)
static boolean	implementsInterface(Class clazz, Class intf) Determine if the given class implements the given interface.
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	isPublic(Class clazz, 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(Class clazz, String name) Attempt to resolve the specified property type through reflection.
static Class	reflectedPropertyClass(String className, String name, ClassLoaderService classLoaderService) Attempt to resolve the specified property type through reflection.
static Method	setterMethodOrNull(Class containerClass, String propertyName, Class propertyType)

Methods inherited from class java.lang.Object

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

Field Detail

NO_PARAM_SIGNATURE

public static final Class[] NO_PARAM_SIGNATURE

NO_PARAMS

public static final Object[] NO_PARAMS

SINGLE_OBJECT_PARAM_SIGNATURE

public static final Class[] SINGLE_OBJECT_PARAM_SIGNATURE

Method Detail

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.

implementsInterface

public static boolean implementsInterface(Class clazz,
                                          Class intf)

Determine if the given class implements the given interface.

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

@Deprecated
public static Class classForName(String name)
                                      throws ClassNotFoundException

Deprecated. Depending on context, either ClassLoaderService or ClassLoaderAccess should be preferred

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(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,
                                           ClassLoaderService classLoaderService)
                                    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.

classLoaderService - ClassLoader services

Returns:

The type of the property.

Throws:

MappingException - Indicates we were unable to locate the property.

reflectedPropertyClass

public static Class reflectedPropertyClass(Class clazz,
                                           String name)
                                    throws MappingException

Attempt to resolve the specified property type through reflection.

Parameters:

clazz - 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.

getConstantValue

public static Object getConstantValue(String name,
                                      SessionFactoryImplementor factory)

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???)

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,
                                         Type[] types)
                                  throws PropertyNotFoundException

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

Parameters:

clazz - The class needing instantiation

types - 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)

findField

public static Field findField(Class containerClass,
                              String propertyName)

ensureAccessibility

public static void ensureAccessibility(AccessibleObject accessibleObject)

findGetterMethod

public static Method findGetterMethod(Class containerClass,
                                      String propertyName)

getterMethodOrNull

public static Method getterMethodOrNull(Class containerJavaType,
                                        String propertyName)

setterMethodOrNull

public static Method setterMethodOrNull(Class containerClass,
                                        String propertyName,
                                        Class propertyType)

findSetterMethod

public static Method findSetterMethod(Class containerClass,
                                      String propertyName,
                                      Class propertyType)

findGetterMethodForFieldAccess

public static Method findGetterMethodForFieldAccess(Field field,
                                                    String propertyName)

Similar to getterMethodOrNull(java.lang.Class, java.lang.String), except that here we are just looking for the corresponding getter for a field (defined as field access) if one exists. We do not look at supers, although conceivably the super could declare the method as an abstract - but again, that is such an edge case...