| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.springframework.util.ReflectionUtils
public abstract class ReflectionUtils
Simple utility class for working with the reflection API and handling reflection exceptions.
Only intended for internal use.
| Nested Class Summary | |
|---|---|
| static interface | ReflectionUtils.FieldCallbackCallback interface invoked on each field in the hierarchy. | 
| static interface | ReflectionUtils.FieldFilterCallback optionally used to filter fields to be operated on by a field callback. | 
| static interface | ReflectionUtils.MethodCallbackAction to take on each method. | 
| static interface | ReflectionUtils.MethodFilterCallback optionally used to method fields to be operated on by a method callback. | 
| Field Summary | |
|---|---|
| static ReflectionUtils.FieldFilter | COPYABLE_FIELDSPre-built FieldFilter that matches all non-static, non-final fields. | 
| Constructor Summary | |
|---|---|
| ReflectionUtils() | |
| Method Summary | |
|---|---|
| static boolean | declaresException(Method method,
                  Class exceptionType)Determine whether the given method explicitly declares the given exception or one of its superclasses, which means that an exception of that type can be propagated as-is within a reflective invocation. | 
| static void | doWithFields(Class targetClass,
             ReflectionUtils.FieldCallback fc)Invoke the given callback on all fields in the target class, going up the class hierarchy to get all declared fields. | 
| static void | doWithFields(Class targetClass,
             ReflectionUtils.FieldCallback fc,
             ReflectionUtils.FieldFilter ff)Invoke the given callback on all fields in the target class, going up the class hierarchy to get all declared fields. | 
| static void | doWithMethods(Class targetClass,
              ReflectionUtils.MethodCallback mc)Perform the given callback operation on all matching methods of the given class and superclasses. | 
| static void | doWithMethods(Class targetClass,
              ReflectionUtils.MethodCallback mc,
              ReflectionUtils.MethodFilter mf)Perform the given callback operation on all matching methods of the given class and superclasses. | 
| static Field | findField(Class clazz,
          String name)Attempt to find a fieldon the suppliedClasswith
 the suppliedname. | 
| static Field | findField(Class clazz,
          String name,
          Class type)Attempt to find a fieldon the suppliedClasswith
 the suppliednameand/ortype. | 
| static Method | findMethod(Class clazz,
           String name)Attempt to find a Methodon the supplied class with the supplied name
 and no parameters. | 
| static Method | findMethod(Class clazz,
           String name,
           Class[] paramTypes)Attempt to find a Methodon the supplied class with the supplied name
 and parameter types. | 
| static Method[] | getAllDeclaredMethods(Class leafClass)Get all declared methods on the leaf class and all superclasses. | 
| static Object | getField(Field field,
         Object target)Get the field represented by the supplied field objecton
 the specifiedtarget object. | 
| static void | handleInvocationTargetException(InvocationTargetException ex)Handle the given invocation target exception. | 
| static void | handleReflectionException(Exception ex)Handle the given reflection exception. | 
| static Object | invokeJdbcMethod(Method method,
                 Object target)Invoke the specified JDBC API Methodagainst the supplied
 target object with no arguments. | 
| static Object | invokeJdbcMethod(Method method,
                 Object target,
                 Object[] args)Invoke the specified JDBC API Methodagainst the supplied
 target object with the supplied arguments. | 
| static Object | invokeMethod(Method method,
             Object target)Invoke the specified Methodagainst the supplied target object
 with no arguments. | 
| static Object | invokeMethod(Method method,
             Object target,
             Object[] args)Invoke the specified Methodagainst the supplied target object
 with the supplied arguments. | 
| static boolean | isEqualsMethod(Method method)Determine whether the given method is an "equals" method. | 
| static boolean | isHashCodeMethod(Method method)Determine whether the given method is a "hashCode" method. | 
| static boolean | isPublicStaticFinal(Field field)Determine whether the given field is a "public static final" constant. | 
| static boolean | isToStringMethod(Method method)Determine whether the given method is a "toString" method. | 
| static void | makeAccessible(Constructor ctor)Make the given constructor accessible, explicitly setting it accessible if necessary. | 
| static void | makeAccessible(Field field)Make the given field accessible, explicitly setting it accessible if necessary. | 
| static void | makeAccessible(Method method)Make the given method accessible, explicitly setting it accessible if necessary. | 
| static void | rethrowException(Throwable ex)Rethrow the given exception, which is presumably the
 target exception of anInvocationTargetException. | 
| static void | rethrowRuntimeException(Throwable ex)Rethrow the given exception, which is presumably the
 target exception of anInvocationTargetException. | 
| static void | setField(Field field,
         Object target,
         Object value)Set the field represented by the supplied field objecton
 the specifiedtarget objectto the specifiedvalue. | 
| static void | shallowCopyFieldState(Object src,
                      Object dest)Given the source object and the destination, which must be the same class or a subclass, copy all fields, including inherited fields. | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
|---|
public static ReflectionUtils.FieldFilter COPYABLE_FIELDS
| Constructor Detail | 
|---|
public ReflectionUtils()
| Method Detail | 
|---|
public static Field findField(Class clazz,
                              String name)
field on the supplied Class with
 the supplied name. Searches all superclasses up to Object.
clazz - the class to introspectname - the name of the field
null if not found
public static Field findField(Class clazz,
                              String name,
                              Class type)
field on the supplied Class with
 the supplied name and/or type. Searches all
 superclasses up to Object.
clazz - the class to introspectname - the name of the field (may be null if type is specified)type - the type of the field (may be null if name is specified)
null if not found
public static void setField(Field field,
                            Object target,
                            Object value)
field object on
 the specified target object to the specified
 value. In accordance with
 Field.set(Object, Object) semantics, the new value is
 automatically unwrapped if the underlying field has a primitive type.
 Thrown exceptions are handled via a call to
 handleReflectionException(Exception).
field - the field to settarget - the target object on which to set the fieldvalue - the value to set; may be null
public static Object getField(Field field,
                              Object target)
field object on
 the specified target object. In accordance with
 Field.get(Object) semantics, the returned value is
 automatically wrapped if the underlying field has a primitive type.
 Thrown exceptions are handled via a call to
 handleReflectionException(Exception).
field - the field to gettarget - the target object from which to get the field
public static Method findMethod(Class clazz,
                                String name)
Method on the supplied class with the supplied name
 and no parameters. Searches all superclasses up to Object.
 Returns null if no Method can be found.
clazz - the class to introspectname - the name of the method
null if none found
public static Method findMethod(Class clazz,
                                String name,
                                Class[] paramTypes)
Method on the supplied class with the supplied name
 and parameter types. Searches all superclasses up to Object.
 Returns null if no Method can be found.
clazz - the class to introspectname - the name of the methodparamTypes - the parameter types of the method
 (may be null to indicate any signature)
null if none found
public static Object invokeMethod(Method method,
                                  Object target)
Method against the supplied target object
 with no arguments. The target object can be null when
 invoking a static Method.
 Thrown exceptions are handled via a call to handleReflectionException(java.lang.Exception).
method - the method to invoketarget - the target object to invoke the method on
invokeMethod(java.lang.reflect.Method, Object, Object[])
public static Object invokeMethod(Method method,
                                  Object target,
                                  Object[] args)
Method against the supplied target object
 with the supplied arguments. The target object can be null
 when invoking a static Method.
 Thrown exceptions are handled via a call to handleReflectionException(java.lang.Exception).
method - the method to invoketarget - the target object to invoke the method onargs - the invocation arguments (may be null)
public static Object invokeJdbcMethod(Method method,
                                      Object target)
                               throws SQLException
Method against the supplied
 target object with no arguments.
method - the method to invoketarget - the target object to invoke the method on
SQLException - the JDBC API SQLException to rethrow (if any)invokeJdbcMethod(java.lang.reflect.Method, Object, Object[])
public static Object invokeJdbcMethod(Method method,
                                      Object target,
                                      Object[] args)
                               throws SQLException
Method against the supplied
 target object with the supplied arguments.
method - the method to invoketarget - the target object to invoke the method onargs - the invocation arguments (may be null)
SQLException - the JDBC API SQLException to rethrow (if any)invokeMethod(java.lang.reflect.Method, Object, Object[])public static void handleReflectionException(Exception ex)
Throws the underlying RuntimeException or Error in case of an InvocationTargetException with such a root cause. Throws an IllegalStateException with an appropriate message else.
ex - the reflection exception to handlepublic static void handleInvocationTargetException(InvocationTargetException ex)
Throws the underlying RuntimeException or Error in case of such a root cause. Throws an IllegalStateException else.
ex - the invocation target exception to handlepublic static void rethrowRuntimeException(Throwable ex)
exception, which is presumably the
 target exception of an InvocationTargetException.
 Should only be called if no checked exception is expected to be thrown by
 the target method.
 Rethrows the underlying exception cast to an RuntimeException
 or Error if appropriate; otherwise, throws an
 IllegalStateException.
ex - the exception to rethrow
RuntimeException - the rethrown exception
public static void rethrowException(Throwable ex)
                             throws Exception
exception, which is presumably the
 target exception of an InvocationTargetException.
 Should only be called if no checked exception is expected to be thrown by
 the target method.
 Rethrows the underlying exception cast to an Exception or
 Error if appropriate; otherwise, throws an
 IllegalStateException.
ex - the exception to rethrow
Exception - the rethrown exception (in case of a checked exception)
public static boolean declaresException(Method method,
                                        Class exceptionType)
method - the declaring methodexceptionType - the exception to throw
true if the exception can be thrown as-is;
 false if it needs to be wrappedpublic static boolean isPublicStaticFinal(Field field)
field - the field to checkpublic static boolean isEqualsMethod(Method method)
Object.equals(java.lang.Object)public static boolean isHashCodeMethod(Method method)
Object.hashCode()public static boolean isToStringMethod(Method method)
Object.toString()public static void makeAccessible(Field field)
setAccessible(true) method is only called when actually necessary,
 to avoid unnecessary conflicts with a JVM SecurityManager (if active).
field - the field to make accessibleAccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean)public static void makeAccessible(Method method)
setAccessible(true) method is only called when actually necessary,
 to avoid unnecessary conflicts with a JVM SecurityManager (if active).
method - the method to make accessibleAccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean)public static void makeAccessible(Constructor ctor)
setAccessible(true) method is only called when actually necessary,
 to avoid unnecessary conflicts with a JVM SecurityManager (if active).
ctor - the constructor to make accessibleAccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean)
public static void doWithMethods(Class targetClass,
                                 ReflectionUtils.MethodCallback mc)
                          throws IllegalArgumentException
The same named method occurring on subclass and superclass will
 appear twice, unless excluded by a ReflectionUtils.MethodFilter.
targetClass - class to start looking atmc - the callback to invoke for each method
IllegalArgumentExceptiondoWithMethods(Class, MethodCallback, MethodFilter)
public static void doWithMethods(Class targetClass,
                                 ReflectionUtils.MethodCallback mc,
                                 ReflectionUtils.MethodFilter mf)
                          throws IllegalArgumentException
The same named method occurring on subclass and superclass will
 appear twice, unless excluded by the specified ReflectionUtils.MethodFilter.
targetClass - class to start looking atmc - the callback to invoke for each methodmf - the filter that determines the methods to apply the callback to
IllegalArgumentException
public static Method[] getAllDeclaredMethods(Class leafClass)
                                      throws IllegalArgumentException
IllegalArgumentException
public static void doWithFields(Class targetClass,
                                ReflectionUtils.FieldCallback fc)
                         throws IllegalArgumentException
targetClass - the target class to analyzefc - the callback to invoke for each field
IllegalArgumentException
public static void doWithFields(Class targetClass,
                                ReflectionUtils.FieldCallback fc,
                                ReflectionUtils.FieldFilter ff)
                         throws IllegalArgumentException
targetClass - the target class to analyzefc - the callback to invoke for each fieldff - the filter that determines the fields to apply the callback to
IllegalArgumentException
public static void shallowCopyFieldState(Object src,
                                         Object dest)
                                  throws IllegalArgumentException
IllegalArgumentException - if the arguments are incompatible| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||