org.apache.commons.beanutils

Class MethodUtils

public class MethodUtils extends Object

Utility reflection methods focussed on methods in general rather than properties in particular.

Known Limitations

Accessing Public Methods In A Default Access Superclass

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. If this call fails then a warning will be logged and the method may fail.

Author: Craig R. McClanahan Ralph Schaer Chris Audley Rey Frangois Gregor Ra}man Jan Sorensen Robert Burrell Donkin

Nested Class Summary
static classMethodUtils.MethodDescriptor
Represents the key to looking up a Method by reflection.
Field Summary
static WeakHashMapcache
Stores a cache of Methods against MethodDescriptors, in a WeakHashMap.
static Class[]emptyClassArray
An empty class array
static Object[]emptyObjectArray
An empty object array
static Loglog
All logging goes through this logger
static booleanloggedAccessibleWarning
Only log warning about accessibility work around once
Method Summary
static MethodgetAccessibleMethod(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.

static MethodgetAccessibleMethod(Class clazz, String methodName, Class[] parameterTypes)

Return an accessible method (that is, one that can be invoked via reflection) with given name and parameters.

static MethodgetAccessibleMethod(Method method)

Return an accessible method (that is, one that can be invoked via reflection) that implements the specified Method.

static MethodgetAccessibleMethodFromInterfaceNest(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.

static MethodgetMatchingAccessibleMethod(Class clazz, String methodName, Class[] parameterTypes)

Find an accessible method that matches the given name and has compatible parameters.

static ClassgetPrimitiveType(Class wrapperType)
Gets the class for the primitive type corresponding to the primitive wrapper class given.
static ClassgetPrimitiveWrapper(Class primitiveType)
Gets the wrapper object class for the given primitive type class.
static ObjectinvokeExactMethod(Object object, String methodName, Object arg)

Invoke a method whose parameter type matches exactly the object type.

This is a convenient wrapper for {@link #invokeExactMethod(Object object,String methodName,Object [] args)}.

static ObjectinvokeExactMethod(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 {@link #getAccessibleMethod}.

static ObjectinvokeExactMethod(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 {@link #getAccessibleMethod}.

static ObjectinvokeMethod(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 {@link #invokeExactMethod}.

static ObjectinvokeMethod(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 {@link #invokeExactMethod(Object object,String methodName,Object [] args)}.

static ObjectinvokeMethod(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 {@link #invokeExactMethod(Object object,String methodName,Object [] args,Class[] parameterTypes)}.

static booleanisAssignmentCompatible(Class parameterType, Class parameterization)

Determine whether a type can be used as a parameter in a method invocation.

static ClasstoNonPrimitiveClass(Class clazz)
Find a non primitive representation for given primitive class.

Field Detail

cache

private static WeakHashMap cache
Stores a cache of Methods against MethodDescriptors, in a WeakHashMap.

emptyClassArray

private static final Class[] emptyClassArray
An empty class array

emptyObjectArray

private static final Object[] emptyObjectArray
An empty object array

log

private static Log log
All logging goes through this logger

loggedAccessibleWarning

private static boolean loggedAccessibleWarning
Only log warning about accessibility work around once

Method Detail

getAccessibleMethod

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.

Parameters: clazz get method from this class methodName get method with this name parameterType taking this type of parameter

getAccessibleMethod

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 {@link #getAccessibleMethod(Method method)}.

Parameters: clazz get method from this class methodName get method with this name parameterTypes with these parameters types

getAccessibleMethod

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.

Parameters: method The method that we wish to call

getAccessibleMethodFromInterfaceNest

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.

Parameters: clazz Parent class for the interfaces to be checked methodName Method name of the method we wish to call parameterTypes The parameter type signatures

getMatchingAccessibleMethod

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 {@link #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.

Parameters: clazz find method in this class methodName find method with this name parameterTypes find method with compatible parameters

getPrimitiveType

public static Class getPrimitiveType(Class wrapperType)
Gets the class for the primitive type corresponding to the primitive wrapper class given. For example, an instance of Boolean.class returns a boolean.class.

Parameters: wrapperType the

Returns: the primitive type class corresponding to the given wrapper class, null if no match is found

getPrimitiveWrapper

public static Class getPrimitiveWrapper(Class primitiveType)
Gets the wrapper object class for the given primitive type class. For example, passing boolean.class returns Boolean.class

Parameters: primitiveType the primitive type class for which a match is to be found

Returns: the wrapper type associated with the given primitive or null if no match is found

invokeExactMethod

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 {@link #invokeExactMethod(Object object,String methodName,Object [] args)}.

Parameters: object invoke method on this object methodName get method with this name arg use this argument

Throws: NoSuchMethodException if there is no such accessible method InvocationTargetException wraps an exception thrown by the method invoked IllegalAccessException if the requested method is not accessible via reflection

invokeExactMethod

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 {@link #getAccessibleMethod}.

Parameters: object invoke method on this object methodName get method with this name args use these arguments - treat null as empty array

Throws: NoSuchMethodException if there is no such accessible method InvocationTargetException wraps an exception thrown by the method invoked IllegalAccessException if the requested method is not accessible via reflection

invokeExactMethod

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 {@link #getAccessibleMethod}.

Parameters: object invoke method on this object methodName get method with this name args use these arguments - treat null as empty array parameterTypes match these parameters - treat null as empty array

Throws: NoSuchMethodException if there is no such accessible method InvocationTargetException wraps an exception thrown by the method invoked IllegalAccessException if the requested method is not accessible via reflection

invokeMethod

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 {@link #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 {@link #invokeMethod(Object object,String methodName,Object [] args)}.

Parameters: object invoke method on this object methodName get method with this name arg use this argument

Throws: NoSuchMethodException if there is no such accessible method InvocationTargetException wraps an exception thrown by the method invoked IllegalAccessException if the requested method is not accessible via reflection

invokeMethod

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 {@link #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 {@link #invokeMethod(Object object,String methodName,Object [] args,Class[] parameterTypes)}.

Parameters: object invoke method on this object methodName get method with this name args use these arguments - treat null as empty array

Throws: NoSuchMethodException if there is no such accessible method InvocationTargetException wraps an exception thrown by the method invoked IllegalAccessException if the requested method is not accessible via reflection

invokeMethod

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 {@link #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.

Parameters: object invoke method on this object methodName get method with this name args use these arguments - treat null as empty array parameterTypes match these parameters - treat null as empty array

Throws: NoSuchMethodException if there is no such accessible method InvocationTargetException wraps an exception thrown by the method invoked IllegalAccessException if the requested method is not accessible via reflection

isAssignmentCompatible

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.

Parameters: parameterType the type of parameter accepted by the method parameterization the type of parameter being tested

Returns: true if the assignement is compatible.

toNonPrimitiveClass

public static Class toNonPrimitiveClass(Class clazz)
Find a non primitive representation for given primitive class.

Parameters: clazz the class to find a representation for, not null

Returns: the original class if it not a primitive. Otherwise the wrapper class. Not null

Copyright (c) 2001-2004 - Apache Software Foundation