|
Griffon 0.9.5-rc2 | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgriffon.util.MethodUtils
public class MethodUtils extends Object
Utility reflection methods focussed on methods in general rather than properties in particular.
Copied from commons-beanutils, removed dependencies to commons-logging
There is an issue when invoking public methods contained in a default access superclass.
Reflection locates these methods fine and correctly assigns them as public.
However, an IllegalAccessException
is thrown if the method is invoked.
MethodUtils
contains a workaround for this situation.
It will attempt to call setAccessible
on this method.
If this call succeeds, then the method can be invoked as normal.
This call will only succeed when the application has sufficient security privilages.
Nested Class Summary | |
---|---|
private static class |
MethodUtils.MethodDescriptor
Represents the key to looking up a Method by reflection. |
Field Summary | |
---|---|
private static boolean |
CACHE_METHODS
Indicates whether methods should be cached for improved performance. |
private static Class[] |
EMPTY_CLASS_PARAMETERS
An empty class array |
private static Object[] |
EMPTY_OBJECT_ARRAY
An empty object array |
private static Map |
cache
Stores a cache of MethodDescriptor -> Method in a WeakHashMap. |
Constructor Summary | |
MethodUtils()
|
Method Summary | |
---|---|
private static void
|
cacheMethod(MethodUtils.MethodDescriptor md, Method method)
Add a method to the cache. |
static int
|
clearCache()
Clear the method cache. |
static Method
|
getAccessibleMethod(Class clazz, String methodName, Class parameterType)
|
static Method
|
getAccessibleMethod(Class clazz, String methodName, Class[] parameterTypes)
|
static Method
|
getAccessibleMethod(Method method)
|
static Method
|
getAccessibleMethod(Class clazz, Method method)
|
private static Method
|
getAccessibleMethodFromInterfaceNest(Class clazz, String methodName, Class[] parameterTypes)
|
private static Method
|
getAccessibleMethodFromSuperclass(Class clazz, String methodName, Class[] parameterTypes)
|
private static Method
|
getCachedMethod(MethodUtils.MethodDescriptor md)
Return the method from the cache, if present. |
static Method
|
getMatchingAccessibleMethod(Class clazz, String methodName, Class[] parameterTypes)
|
private static float
|
getObjectTransformationCost(Class srcClass, Class destClass)
Gets the number of steps required needed to turn the source class into the destination class. |
static Class
|
getPrimitiveType(Class wrapperType)
Gets the class for the primitive type corresponding to the primitive wrapper class given. |
static Class
|
getPrimitiveWrapper(Class primitiveType)
Gets the wrapper object class for the given primitive type class. |
private static float
|
getTotalTransformationCost(Class[] srcArgs, Class[] destArgs)
Returns the sum of the object transformation cost for each class in the source argument list. |
static Object
|
invokeExactMethod(Object object, String methodName, Object arg)
|
static Object
|
invokeExactMethod(Object object, String methodName, Object[] args)
|
static Object
|
invokeExactMethod(Object object, String methodName, Object[] args, Class[] parameterTypes)
|
static Object
|
invokeExactStaticMethod(Class objectClass, String methodName, Object[] args, Class[] parameterTypes)
|
static Object
|
invokeExactStaticMethod(Class objectClass, String methodName, Object arg)
|
static Object
|
invokeExactStaticMethod(Class objectClass, String methodName, Object[] args)
|
static Object
|
invokeMethod(Object object, String methodName, Object arg)
|
static Object
|
invokeMethod(Object object, String methodName, Object[] args)
|
static Object
|
invokeMethod(Object object, String methodName, Object[] args, Class[] parameterTypes)
|
static Object
|
invokeStaticMethod(Class objectClass, String methodName, Object arg)
|
static Object
|
invokeStaticMethod(Class objectClass, String methodName, Object[] args)
|
static Object
|
invokeStaticMethod(Class objectClass, String methodName, Object[] args, Class[] parameterTypes)
|
static boolean
|
isAssignmentCompatible(Class parameterType, Class parameterization)
|
static void
|
setCacheMethods(boolean cacheMethods)
Set whether methods should be cached for greater performance or not,
default is |
private static void
|
setMethodAccessible(Method method)
Try to make the method accessible |
static Class
|
toNonPrimitiveClass(Class clazz)
Find a non primitive representation for given primitive class. |
Methods inherited from class Object | |
---|---|
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
Field Detail |
---|
private static boolean CACHE_METHODS
private static final Class[] EMPTY_CLASS_PARAMETERS
private static final Object[] EMPTY_OBJECT_ARRAY
private static final Map cache
Constructor Detail |
---|
MethodUtils()
Method Detail |
---|
private static void cacheMethod(MethodUtils.MethodDescriptor md, Method method)
md
- The method descriptormethod
- The method to cache
public static int clearCache()
public static Method getAccessibleMethod(Class clazz, String methodName, Class parameterType)
Return an accessible method (that is, one that can be invoked via
reflection) with given name and a single parameter. If no such method
can be found, return null
.
Basically, a convenience wrapper that constructs a Class
array for you.
clazz
- get method from this classmethodName
- get method with this nameparameterType
- taking this type of parameter
public static Method getAccessibleMethod(Class clazz, String methodName, Class[] parameterTypes)
Return an accessible method (that is, one that can be invoked via
reflection) with given name and parameters. If no such method
can be found, return null
.
This is just a convenient wrapper for
getAccessibleMethod(Method method).
clazz
- get method from this classmethodName
- get method with this nameparameterTypes
- with these parameters types
public static Method getAccessibleMethod(Method method)
Return an accessible method (that is, one that can be invoked via
reflection) that implements the specified Method. If no such method
can be found, return null
.
method
- The method that we wish to call
public static Method getAccessibleMethod(Class clazz, Method method)
Return an accessible method (that is, one that can be invoked via
reflection) that implements the specified Method. If no such method
can be found, return null
.
clazz
- The class of the objectmethod
- The method that we wish to call
private static Method getAccessibleMethodFromInterfaceNest(Class clazz, String methodName, Class[] parameterTypes)
Return an accessible method (that is, one that can be invoked via
reflection) that implements the specified method, by scanning through
all implemented interfaces and subinterfaces. If no such method
can be found, return null
.
There isn't any good reason why this method must be private. It is because there doesn't seem any reason why other classes should call this rather than the higher level methods.
clazz
- Parent class for the interfaces to be checkedmethodName
- Method name of the method we wish to callparameterTypes
- The parameter type signatures
private static Method getAccessibleMethodFromSuperclass(Class clazz, String methodName, Class[] parameterTypes)
Return an accessible method (that is, one that can be invoked via
reflection) by scanning through the superclasses. If no such method
can be found, return null
.
clazz
- Class to be checkedmethodName
- Method name of the method we wish to callparameterTypes
- The parameter type signatures
private static Method getCachedMethod(MethodUtils.MethodDescriptor md)
md
- The method descriptor
public static Method getMatchingAccessibleMethod(Class clazz, String methodName, Class[] parameterTypes)
Find an accessible method that matches the given name and has compatible parameters. Compatible parameters mean that every method parameter is assignable from the given parameters. In other words, it finds a method with the given name that will take the parameters given.
This method is slightly undeterminstic since it loops through methods names and return the first matching method.
This method is used by invokeMethod(Object object, String methodName, Object [] args, Class[] parameterTypes).
This method can match primitive parameter by passing in wrapper classes.
For example, a Boolean
will match a primitive boolean
parameter.
clazz
- find method in this classmethodName
- find method with this nameparameterTypes
- find method with compatible parameters
private static float getObjectTransformationCost(Class srcClass, Class destClass)
srcClass
- The source classdestClass
- The destination class
public static Class getPrimitiveType(Class wrapperType)
Boolean.class
returns a boolean.class
.
wrapperType
- the
public static Class getPrimitiveWrapper(Class primitiveType)
boolean.class
returns Boolean.class
primitiveType
- the primitive type class for which a match is to be found
private static float getTotalTransformationCost(Class[] srcArgs, Class[] destArgs)
srcArgs
- The source argumentsdestArgs
- The destination arguments
public static Object invokeExactMethod(Object object, String methodName, Object arg)
Invoke a method whose parameter type matches exactly the object type.
This is a convenient wrapper for invokeExactMethod(Object object, String methodName, Object [] args).
object
- invoke method on this objectmethodName
- get method with this namearg
- use this argument
public static Object invokeExactMethod(Object object, String methodName, Object[] args)
Invoke a method whose parameter types match exactly the object types.
This uses reflection to invoke the method obtained from a call to
getAccessibleMethod()
.
object
- invoke method on this objectmethodName
- get method with this nameargs
- use these arguments - treat null as empty array
public static Object invokeExactMethod(Object object, String methodName, Object[] args, Class[] parameterTypes)
Invoke a method whose parameter types match exactly the parameter types given.
This uses reflection to invoke the method obtained from a call to
getAccessibleMethod()
.
object
- invoke method on this objectmethodName
- get method with this nameargs
- use these arguments - treat null as empty arrayparameterTypes
- match these parameters - treat null as empty array
public static Object invokeExactStaticMethod(Class objectClass, String methodName, Object[] args, Class[] parameterTypes)
Invoke a static method whose parameter types match exactly the parameter types given.
This uses reflection to invoke the method obtained from a call to getAccessibleMethod(Class, String, Class[]).
objectClass
- invoke static method on this classmethodName
- get method with this nameargs
- use these arguments - treat null as empty arrayparameterTypes
- match these parameters - treat null as empty array
public static Object invokeExactStaticMethod(Class objectClass, String methodName, Object arg)
Invoke a static method whose parameter type matches exactly the object type.
This is a convenient wrapper for invokeExactStaticMethod(Class objectClass, String methodName, Object [] args).
objectClass
- invoke static method on this classmethodName
- get method with this namearg
- use this argument
public static Object invokeExactStaticMethod(Class objectClass, String methodName, Object[] args)
Invoke a static method whose parameter types match exactly the object types.
This uses reflection to invoke the method obtained from a call to getAccessibleMethod(Class, String, Class[]).
objectClass
- invoke static method on this classmethodName
- get method with this nameargs
- use these arguments - treat null as empty array
public static Object invokeMethod(Object object, String methodName, Object arg)
Invoke a named method whose parameter type matches the object type.
The behaviour of this method is less deterministic
than invokeExactMethod()
.
It loops through all methods with names that match
and then executes the first it finds with compatable parameters.
This method supports calls to methods taking primitive parameters
via passing in wrapping classes. So, for example, a Boolean
class
would match a boolean
primitive.
This is a convenient wrapper for invokeMethod(Object object, String methodName, Object [] args).
object
- invoke method on this objectmethodName
- get method with this namearg
- use this argument
public static Object invokeMethod(Object object, String methodName, Object[] args)
Invoke a named method whose parameter type matches the object type.
The behaviour of this method is less deterministic than invokeExactMethod(Object object, String methodName, Object [] args). It loops through all methods with names that match and then executes the first it finds with compatable parameters.
This method supports calls to methods taking primitive parameters
via passing in wrapping classes. So, for example, a Boolean
class
would match a boolean
primitive.
This is a convenient wrapper for invokeMethod(Object object, String methodName, Object [] args, Class[] parameterTypes).
object
- invoke method on this objectmethodName
- get method with this nameargs
- use these arguments - treat null as empty array
public static Object invokeMethod(Object object, String methodName, Object[] args, Class[] parameterTypes)
Invoke a named method whose parameter type matches the object type.
The behaviour of this method is less deterministic than invokeExactMethod(Object object, String methodName, Object [] args, Class[] parameterTypes). It loops through all methods with names that match and then executes the first it finds with compatable parameters.
This method supports calls to methods taking primitive parameters
via passing in wrapping classes. So, for example, a Boolean
class
would match a boolean
primitive.
object
- invoke method on this objectmethodName
- get method with this nameargs
- use these arguments - treat null as empty arrayparameterTypes
- match these parameters - treat null as empty array
public static Object invokeStaticMethod(Class objectClass, String methodName, Object arg)
Invoke a named static method whose parameter type matches the object type.
The behaviour of this method is less deterministic than invokeExactMethod(Object, String, Object[], Class[]). It loops through all methods with names that match and then executes the first it finds with compatable parameters.
This method supports calls to methods taking primitive parameters
via passing in wrapping classes. So, for example, a Boolean
class
would match a boolean
primitive.
This is a convenient wrapper for invokeStaticMethod(Class objectClass, String methodName, Object [] args).
objectClass
- invoke static method on this classmethodName
- get method with this namearg
- use this argument
public static Object invokeStaticMethod(Class objectClass, String methodName, Object[] args)
Invoke a named static method whose parameter type matches the object type.
The behaviour of this method is less deterministic than invokeExactMethod(Object object, String methodName, Object [] args). It loops through all methods with names that match and then executes the first it finds with compatable parameters.
This method supports calls to methods taking primitive parameters
via passing in wrapping classes. So, for example, a Boolean
class
would match a boolean
primitive.
This is a convenient wrapper for invokeStaticMethod(Class objectClass, String methodName, Object [] args, Class[] parameterTypes).
objectClass
- invoke static method on this classmethodName
- get method with this nameargs
- use these arguments - treat null as empty array
public static Object invokeStaticMethod(Class objectClass, String methodName, Object[] args, Class[] parameterTypes)
Invoke a named static method whose parameter type matches the object type.
The behaviour of this method is less deterministic than invokeExactStaticMethod(Class objectClass, String methodName, Object [] args, Class[] parameterTypes). It loops through all methods with names that match and then executes the first it finds with compatable parameters.
This method supports calls to methods taking primitive parameters
via passing in wrapping classes. So, for example, a Boolean
class
would match a boolean
primitive.
objectClass
- invoke static method on this classmethodName
- get method with this nameargs
- use these arguments - treat null as empty arrayparameterTypes
- match these parameters - treat null as empty array
public static final boolean isAssignmentCompatible(Class parameterType, Class parameterization)
Determine whether a type can be used as a parameter in a method invocation. This method handles primitive conversions correctly.
In order words, it will match a Boolean
to a boolean
,
a Long
to a long
,
a Float
to a float
,
a Integer
to a int
,
and a Double
to a double
.
Now logic widening matches are allowed.
For example, a Long
will not match a int
.
parameterType
- the type of parameter accepted by the methodparameterization
- the type of parameter being tested
public static void setCacheMethods(boolean cacheMethods)
true
.
cacheMethods
- true
if methods should be
cached for greater performance, otherwise false
private static void setMethodAccessible(Method method)
method
- The source arguments
public static Class toNonPrimitiveClass(Class clazz)
clazz
- the class to find a representation for, not null
Groovy Documentation