org.frameworkset.util

类 ReflectionUtils

java.lang.Object

org.frameworkset.util.ReflectionUtils

public abstract class ReflectionUtils
extends java.lang.Object

Title: ReflectionUtils.java

Description:

bboss workgroup

Copyright (c) 2008

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	ReflectionUtils.FieldCallback Callback interface invoked on each field in the hierarchy.
static interface	ReflectionUtils.FieldFilter Callback optionally used to filter fields to be operated on by a field callback.
static interface	ReflectionUtils.MethodCallback Action to take on each method.
static interface	ReflectionUtils.MethodFilter Callback optionally used to method fields to be operated on by a method callback.

字段概要

字段

限定符和类型	字段和说明
static ReflectionUtils.FieldFilter	COPYABLE_FIELDS Pre-built FieldFilter that matches all non-static, non-final fields.

构造器概要

构造器

构造器和说明
ReflectionUtils()

方法概要

限定符和类型	方法和说明
static boolean	declaresException(java.lang.reflect.Method method, java.lang.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	doWithMethods(java.lang.Class targetClass, ReflectionUtils.MethodCallback mc) Perform the given callback operation on all matching methods of the given class and superclasses.
static void	doWithMethods(java.lang.Class targetClass, ReflectionUtils.MethodCallback mc, ReflectionUtils.MethodFilter mf) Perform the given callback operation on all matching methods of the given class and superclasses.
static java.lang.reflect.Field	findField(java.lang.Class clazz, java.lang.String name) Attempt to find a field on the supplied Class with the supplied name.
static java.lang.reflect.Method	findMethod(java.lang.Class clazz, java.lang.String name) Attempt to find a Method on the supplied class with the supplied name and no parameters.
static java.lang.reflect.Method	findMethod(java.lang.Class clazz, java.lang.String name, java.lang.Class... paramTypes) Attempt to find a Method on the supplied class with the supplied name and parameter types.
static java.lang.reflect.Method[]	getAllDeclaredMethods(java.lang.Class leafClass) Get all declared methods on the leaf class and all superclasses.
static java.lang.Object	getField(java.lang.reflect.Field field, java.lang.Object target) Get the field represented by the supplied field object on the specified target object.
static void	handleInvocationTargetException(java.lang.reflect.InvocationTargetException ex) Handle the given invocation target exception.
static void	handleReflectionException(java.lang.Exception ex) Handle the given reflection exception.
static java.lang.Object	invokeJdbcMethod(java.lang.reflect.Method method, java.lang.Object target) Invoke the specified JDBC API Method against the supplied target object with no arguments.
static java.lang.Object	invokeJdbcMethod(java.lang.reflect.Method method, java.lang.Object target, java.lang.Object... args) Invoke the specified JDBC API Method against the supplied target object with the supplied arguments.
static java.lang.Object	invokeMethod(java.lang.reflect.Method method, java.lang.Object target) Invoke the specified Method against the supplied target object with no arguments.
static java.lang.Object	invokeMethod(java.lang.reflect.Method method, java.lang.Object target, java.lang.Object... args) Invoke the specified Method against the supplied target object with the supplied arguments.
static boolean	isAccessible(java.lang.reflect.Method method)
static boolean	isEqualsMethod(java.lang.reflect.Method method) Determine whether the given method is an "equals" method.
static boolean	isHashCodeMethod(java.lang.reflect.Method method) Determine whether the given method is a "hashCode" method.
static boolean	isPublicStaticFinal(java.lang.reflect.Field field) Determine whether the given field is a "public static final" constant.
static boolean	isToStringMethod(java.lang.reflect.Method method) Determine whether the given method is a "toString" method.
static void	makeAccessible(java.lang.reflect.Constructor ctor) Make the given constructor accessible, explicitly setting it accessible if necessary.
static void	makeAccessible(java.lang.reflect.Field field) Make the given field accessible, explicitly setting it accessible if necessary.
static void	makeAccessible(java.lang.reflect.Method method) Make the given method accessible, explicitly setting it accessible if necessary.
static void	rethrowException(java.lang.Throwable ex) Rethrow the given exception, which is presumably the target exception of an InvocationTargetException.
static void	rethrowRuntimeException(java.lang.Throwable ex) Rethrow the given exception, which is presumably the target exception of an InvocationTargetException.
static void	setField(java.lang.reflect.Field field, java.lang.Object target, java.lang.Object value) Set the field represented by the supplied field object on the specified target object to the specified value.

从类继承的方法 java.lang.Object

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

字段详细资料

COPYABLE_FIELDS

public static ReflectionUtils.FieldFilter COPYABLE_FIELDS

Pre-built FieldFilter that matches all non-static, non-final fields.

构造器详细资料

ReflectionUtils

public ReflectionUtils()

方法详细资料

findField

public static java.lang.reflect.Field findField(java.lang.Class clazz,
                                                java.lang.String name)

Attempt to find a field on the supplied Class with the supplied name. Searches all superclasses up to Object.

参数:

clazz - the class to introspect

name - the name of the field

返回:

the corresponding Field object, or null if not found

setField

public static void setField(java.lang.reflect.Field field,
                            java.lang.Object target,
                            java.lang.Object value)

Set the field represented by the supplied 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 set

target - the target object on which to set the field

value - the value to set; may be null

getField

public static java.lang.Object getField(java.lang.reflect.Field field,
                                        java.lang.Object target)

Get the field represented by the supplied 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 get

target - the target object from which to get the field

返回:

the field's current value

findMethod

public static java.lang.reflect.Method findMethod(java.lang.Class clazz,
                                                  java.lang.String name)

Attempt to find a 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 introspect

name - the name of the method

返回:

the Method object, or null if none found

findMethod

public static java.lang.reflect.Method findMethod(java.lang.Class clazz,
                                                  java.lang.String name,
                                                  java.lang.Class... paramTypes)

Attempt to find a 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 introspect

name - the name of the method

paramTypes - the parameter types of the method (may be null to indicate any signature)

返回:

the Method object, or null if none found

invokeMethod

public static java.lang.Object invokeMethod(java.lang.reflect.Method method,
                                            java.lang.Object target)

Invoke the specified 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 invoke

target - the target object to invoke the method on

返回:

the invocation result, if any

另请参阅:

invokeMethod(Method, Object, Object[])

invokeMethod

public static java.lang.Object invokeMethod(java.lang.reflect.Method method,
                                            java.lang.Object target,
                                            java.lang.Object... args)

Invoke the specified 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 invoke

target - the target object to invoke the method on

args - the invocation arguments (may be null)

返回:

the invocation result, if any

invokeJdbcMethod

public static java.lang.Object invokeJdbcMethod(java.lang.reflect.Method method,
                                                java.lang.Object target)
                                         throws java.sql.SQLException

Invoke the specified JDBC API Method against the supplied target object with no arguments.

参数:

method - the method to invoke

target - the target object to invoke the method on

返回:

the invocation result, if any

抛出:

java.sql.SQLException - the JDBC API SQLException to rethrow (if any)

另请参阅:

invokeJdbcMethod(Method, Object, Object[])

invokeJdbcMethod

public static java.lang.Object invokeJdbcMethod(java.lang.reflect.Method method,
                                                java.lang.Object target,
                                                java.lang.Object... args)
                                         throws java.sql.SQLException

Invoke the specified JDBC API Method against the supplied target object with the supplied arguments.

参数:

method - the method to invoke

target - the target object to invoke the method on

args - the invocation arguments (may be null)

返回:

the invocation result, if any

抛出:

java.sql.SQLException - the JDBC API SQLException to rethrow (if any)

另请参阅:

invokeMethod(Method, Object, Object[])

handleReflectionException

public static void handleReflectionException(java.lang.Exception ex)

Handle the given reflection exception. Should only be called if no checked exception is expected to be thrown by the target method.

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 handle

handleInvocationTargetException

public static void handleInvocationTargetException(java.lang.reflect.InvocationTargetException ex)

Handle the given invocation target exception. Should only be called if no checked exception is expected to be thrown by the target method.

Throws the underlying RuntimeException or Error in case of such a root cause. Throws an IllegalStateException else.

参数:

ex - the invocation target exception to handle

rethrowRuntimeException

public static void rethrowRuntimeException(java.lang.Throwable ex)

Rethrow the given 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

抛出:

java.lang.RuntimeException - the rethrown exception

rethrowException

public static void rethrowException(java.lang.Throwable ex)
                             throws java.lang.Exception

Rethrow the given 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

抛出:

java.lang.Exception - the rethrown exception (in case of a checked exception)

declaresException

public static boolean declaresException(java.lang.reflect.Method method,
                                        java.lang.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.

参数:

method - the declaring method

exceptionType - the exception to throw

返回:

true if the exception can be thrown as-is; false if it needs to be wrapped

isPublicStaticFinal

public static boolean isPublicStaticFinal(java.lang.reflect.Field field)

Determine whether the given field is a "public static final" constant.

参数:

field - the field to check

isEqualsMethod

public static boolean isEqualsMethod(java.lang.reflect.Method method)

Determine whether the given method is an "equals" method.

另请参阅:

Object.equals(java.lang.Object)

isHashCodeMethod

public static boolean isHashCodeMethod(java.lang.reflect.Method method)

Determine whether the given method is a "hashCode" method.

另请参阅:

Object.hashCode()

isToStringMethod

public static boolean isToStringMethod(java.lang.reflect.Method method)

Determine whether the given method is a "toString" method.

另请参阅:

Object.toString()

makeAccessible

public static void makeAccessible(java.lang.reflect.Field field)

Make the given field accessible, explicitly setting it accessible if necessary. The setAccessible(true) method is only called when actually necessary, to avoid unnecessary conflicts with a JVM SecurityManager (if active).

参数:

field - the field to make accessible

另请参阅:

AccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean)

makeAccessible

public static void makeAccessible(java.lang.reflect.Method method)

Make the given method accessible, explicitly setting it accessible if necessary. The setAccessible(true) method is only called when actually necessary, to avoid unnecessary conflicts with a JVM SecurityManager (if active).

参数:

method - the method to make accessible

另请参阅:

AccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean)

isAccessible

public static boolean isAccessible(java.lang.reflect.Method method)

makeAccessible

public static void makeAccessible(java.lang.reflect.Constructor ctor)

Make the given constructor accessible, explicitly setting it accessible if necessary. The setAccessible(true) method is only called when actually necessary, to avoid unnecessary conflicts with a JVM SecurityManager (if active).

参数:

ctor - the constructor to make accessible

另请参阅:

AccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean)

doWithMethods

public static void doWithMethods(java.lang.Class targetClass,
                                 ReflectionUtils.MethodCallback mc)
                          throws java.lang.IllegalArgumentException

Perform the given callback operation on all matching methods of the given class and superclasses.

The same named method occurring on subclass and superclass will appear twice, unless excluded by a ReflectionUtils.MethodFilter.

参数:

targetClass - class to start looking at

mc - the callback to invoke for each method

抛出:

java.lang.IllegalArgumentException

另请参阅:

doWithMethods(Class, MethodCallback, MethodFilter)

doWithMethods

public static void doWithMethods(java.lang.Class targetClass,
                                 ReflectionUtils.MethodCallback mc,
                                 ReflectionUtils.MethodFilter mf)
                          throws java.lang.IllegalArgumentException

Perform the given callback operation on all matching methods of the given class and superclasses.

The same named method occurring on subclass and superclass will appear twice, unless excluded by the specified ReflectionUtils.MethodFilter.

参数:

targetClass - class to start looking at

mc - the callback to invoke for each method

mf - the filter that determines the methods to apply the callback to

抛出:

java.lang.IllegalArgumentException

getAllDeclaredMethods

public static java.lang.reflect.Method[] getAllDeclaredMethods(java.lang.Class leafClass)
                                                        throws java.lang.IllegalArgumentException

Get all declared methods on the leaf class and all superclasses. Leaf class methods are included first.

抛出:

java.lang.IllegalArgumentException