Class MethodUtils
Methods, originally from Commons BeanUtils.
Differences from the BeanUtils version may be noted, especially where similar functionality
already existed within Lang.
Known Limitations
Accessing Public Methods In A Default Access Superclass
There is an issue when invoking public methods contained in a default access superclass on JREs prior to 1.4.
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 AccessibleObject.setAccessible(boolean) 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 privileges.
If this call fails then the method may fail.
- Since:
- 2.5
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic MethodgetAccessibleMethod(Class<?> cls, String methodName, Class<?>... parameterTypes) Gets an accessible method (that is, one that can be invoked via reflection) with given name and parameters.static MethodgetAccessibleMethod(Method method) Gets an accessible method (that is, one that can be invoked via reflection) that implements the specified Method.static <A extends Annotation>
AgetAnnotation(Method method, Class<A> annotationCls, boolean searchSupers, boolean ignoreAccess) Gets the annotation object with the given annotation type that is present on the given method or optionally on any equivalent method in super classes and interfaces.static MethodgetMatchingAccessibleMethod(Class<?> cls, String methodName, Class<?>... parameterTypes) Gets an accessible method that matches the given name and has compatible parameters.static MethodgetMatchingMethod(Class<?> cls, String methodName, Class<?>... parameterTypes) Gets a method whether or not it's accessible.static MethodgetMethodObject(Class<?> cls, String name, Class<?>... parameterTypes) Gets a Method or null if adocumentedexception is thrown.getMethodsListWithAnnotation(Class<?> cls, Class<? extends Annotation> annotationCls) Gets all class level public methods of the given class that are annotated with the given annotation.getMethodsListWithAnnotation(Class<?> cls, Class<? extends Annotation> annotationCls, boolean searchSupers, boolean ignoreAccess) Gets all methods of the given class that are annotated with the given annotation.static Method[]getMethodsWithAnnotation(Class<?> cls, Class<? extends Annotation> annotationCls) Gets all class level public methods of the given class that are annotated with the given annotation.static Method[]getMethodsWithAnnotation(Class<?> cls, Class<? extends Annotation> annotationCls, boolean searchSupers, boolean ignoreAccess) Gets all methods of the given class that are annotated with the given annotation.getOverrideHierarchy(Method method, ClassUtils.Interfaces interfacesBehavior) Gets the hierarchy of overridden methods down toresultrespecting generics.static ObjectinvokeExactMethod(Object object, String methodName) Invokes a method whose parameter types match exactly the object types.static ObjectinvokeExactMethod(Object object, String methodName, Object... args) Invokes a method with no parameters.static ObjectinvokeExactMethod(Object object, String methodName, Object[] args, Class<?>[] parameterTypes) Invokes a method whose parameter types match exactly the parameter types given.static ObjectinvokeExactStaticMethod(Class<?> cls, String methodName, Object... args) Invokes astaticmethod whose parameter types match exactly the object types.static ObjectinvokeExactStaticMethod(Class<?> cls, String methodName, Object[] args, Class<?>[] parameterTypes) Invokes astaticmethod whose parameter types match exactly the parameter types given.static ObjectinvokeMethod(Object object, boolean forceAccess, String methodName) Invokes a named method without parameters.static ObjectinvokeMethod(Object object, boolean forceAccess, String methodName, Object... args) Invokes a named method whose parameter type matches the object type.static ObjectinvokeMethod(Object object, boolean forceAccess, String methodName, Object[] args, Class<?>[] parameterTypes) Invokes a named method whose parameter type matches the object type.static ObjectinvokeMethod(Object object, String methodName) Invokes a named method without parameters.static ObjectinvokeMethod(Object object, String methodName, Object... args) Invokes a named method whose parameter type matches the object type.static ObjectinvokeMethod(Object object, String methodName, Object[] args, Class<?>[] parameterTypes) Invokes a named method whose parameter type matches the object type.static ObjectinvokeStaticMethod(Class<?> cls, String methodName, Object... args) Invokes a namedstaticmethod whose parameter type matches the object type.static ObjectinvokeStaticMethod(Class<?> cls, String methodName, Object[] args, Class<?>[] parameterTypes) Invokes a namedstaticmethod whose parameter type matches the object type.
-
Constructor Details
-
MethodUtils
Deprecated.TODO Make private in 4.0.MethodUtilsinstances should NOT be constructed in standard programming. Instead, the class should be used asMethodUtils.getAccessibleMethod(method).This constructor is
publicto permit tools that require a JavaBean instance to operate.
-
-
Method Details
-
getAccessibleMethod
public static Method getAccessibleMethod(Class<?> cls, String methodName, Class<?>... parameterTypes) Gets an accessible method (that is, one that can be invoked via reflection) with given name and parameters. If no such method can be found, returnnull. This is just a convenience wrapper forgetAccessibleMethod(Method).- Parameters:
cls- get method from this classmethodName- get method with this nameparameterTypes- with these parameters types- Returns:
- The accessible method
-
getAccessibleMethod
Gets an accessible method (that is, one that can be invoked via reflection) that implements the specified Method. If no such method can be found, returnnull.- Parameters:
method- The method that we wish to call, may be null.- Returns:
- The accessible method
-
getAnnotation
public static <A extends Annotation> A getAnnotation(Method method, Class<A> annotationCls, boolean searchSupers, boolean ignoreAccess) Gets the annotation object with the given annotation type that is present on the given method or optionally on any equivalent method in super classes and interfaces. Returns null if the annotation type was not present.Stops searching for an annotation once the first annotation of the specified type has been found. Additional annotations of the specified type will be silently ignored.
- Type Parameters:
A- the annotation type- Parameters:
method- theMethodto query, may be null.annotationCls- theAnnotationto check if is present on the methodsearchSupers- determines if a lookup in the entire inheritance hierarchy of the given class is performed if the annotation was not directly presentignoreAccess- determines if underlying method has to be accessible- Returns:
- the first matching annotation, or
nullif not found - Throws:
NullPointerException- if either the method or annotation class isnull- Since:
- 3.6
-
getMatchingAccessibleMethod
public static Method getMatchingAccessibleMethod(Class<?> cls, String methodName, Class<?>... parameterTypes) Gets 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 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
Booleanwill match a primitivebooleanparameter.- Parameters:
cls- find method in this classmethodName- find method with this nameparameterTypes- find method with most compatible parameters- Returns:
- The accessible method
-
getMatchingMethod
Gets a method whether or not it's accessible. If no such method can be found, returnnull.- Parameters:
cls- The class that will be subjected to the method searchmethodName- The method that we wish to callparameterTypes- Argument class types- Returns:
- The method
- Throws:
IllegalStateException- if there is no unique resultNullPointerException- if the class isnull- Since:
- 3.5
-
getMethodObject
Gets a Method or null if adocumentedexception is thrown.- Parameters:
cls- Receiver forClass.getMethod(String, Class...).name- the name of the methodparameterTypes- the list of parameters- Returns:
- a Method or null.
- Since:
- 3.15.0
- See Also:
-
getMethodsListWithAnnotation
public static List<Method> getMethodsListWithAnnotation(Class<?> cls, Class<? extends Annotation> annotationCls) Gets all class level public methods of the given class that are annotated with the given annotation.- Parameters:
cls- theClassto queryannotationCls- theAnnotationthat must be present on a method to be matched- Returns:
- a list of Methods (possibly empty).
- Throws:
NullPointerException- if the class or annotation arenull- Since:
- 3.4
-
getMethodsListWithAnnotation
public static List<Method> getMethodsListWithAnnotation(Class<?> cls, Class<? extends Annotation> annotationCls, boolean searchSupers, boolean ignoreAccess) Gets all methods of the given class that are annotated with the given annotation.- Parameters:
cls- theClassto queryannotationCls- theAnnotationthat must be present on a method to be matchedsearchSupers- determines if a lookup in the entire inheritance hierarchy of the given class should be performedignoreAccess- determines if non-public methods should be considered- Returns:
- a list of Methods (possibly empty).
- Throws:
NullPointerException- if either the class or annotation class isnull- Since:
- 3.6
-
getMethodsWithAnnotation
public static Method[] getMethodsWithAnnotation(Class<?> cls, Class<? extends Annotation> annotationCls) Gets all class level public methods of the given class that are annotated with the given annotation.- Parameters:
cls- theClassto queryannotationCls- theAnnotationthat must be present on a method to be matched- Returns:
- an array of Methods (possibly empty).
- Throws:
NullPointerException- if the class or annotation arenull- Since:
- 3.4
-
getMethodsWithAnnotation
public static Method[] getMethodsWithAnnotation(Class<?> cls, Class<? extends Annotation> annotationCls, boolean searchSupers, boolean ignoreAccess) Gets all methods of the given class that are annotated with the given annotation.- Parameters:
cls- theClassto queryannotationCls- theAnnotationthat must be present on a method to be matchedsearchSupers- determines if a lookup in the entire inheritance hierarchy of the given class should be performedignoreAccess- determines if non-public methods should be considered- Returns:
- an array of Methods (possibly empty).
- Throws:
NullPointerException- if the class or annotation arenull- Since:
- 3.6
-
getOverrideHierarchy
public static Set<Method> getOverrideHierarchy(Method method, ClassUtils.Interfaces interfacesBehavior) Gets the hierarchy of overridden methods down toresultrespecting generics.- Parameters:
method- lowest to considerinterfacesBehavior- whether to search interfaces,nullimpliesfalse- Returns:
- a
Set<Method>in ascending order from sub- to superclass - Throws:
NullPointerException- if the specified method isnull- Since:
- 3.2
-
invokeExactMethod
public static Object invokeExactMethod(Object object, String methodName) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException Invokes a method whose parameter types match exactly the object types.This uses reflection to invoke the method obtained from a call to
getAccessibleMethod(java.lang.Class<?>, java.lang.String, java.lang.Class<?>...)(Class, String, Class[])}.- Parameters:
object- invoke method on this objectmethodName- get method with this name- Returns:
- The value returned by the invoked method
- Throws:
NoSuchMethodException- if there is no such accessible methodInvocationTargetException- wraps an exception thrown by the method invokedIllegalAccessException- if the requested method is not accessible via reflection- Since:
- 3.4
-
invokeExactMethod
public static Object invokeExactMethod(Object object, String methodName, Object... args) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException Invokes a method with no parameters.This uses reflection to invoke the method obtained from a call to
getAccessibleMethod(java.lang.Class<?>, java.lang.String, java.lang.Class<?>...)(Class, String, Class[])}.- Parameters:
object- invoke method on this objectmethodName- get method with this nameargs- use these arguments - treat null as empty array- Returns:
- The value returned by the invoked method
- Throws:
NoSuchMethodException- if there is no such accessible methodInvocationTargetException- wraps an exception thrown by the method invokedIllegalAccessException- if the requested method is not accessible via reflectionNullPointerException- if the object or method name arenull
-
invokeExactMethod
public static Object invokeExactMethod(Object object, String methodName, Object[] args, Class<?>[] parameterTypes) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException Invokes a 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[]).- Parameters:
object- invoke method on this objectmethodName- get method with this nameargs- use these arguments - treat null as empty arrayparameterTypes- match these parameters - treatnullas empty array- Returns:
- The value returned by the invoked method
- Throws:
NoSuchMethodException- if there is no such accessible methodInvocationTargetException- wraps an exception thrown by the method invokedIllegalAccessException- if the requested method is not accessible via reflectionNullPointerException- if the object or method name arenull
-
invokeExactStaticMethod
public static Object invokeExactStaticMethod(Class<?> cls, String methodName, Object... args) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException Invokes astaticmethod whose parameter types match exactly the object types.This uses reflection to invoke the method obtained from a call to
getAccessibleMethod(Class, String, Class[]).- Parameters:
cls- invoke static method on this classmethodName- get method with this nameargs- use these arguments - treatnullas empty array- Returns:
- The value returned by the invoked method
- Throws:
NoSuchMethodException- if there is no such accessible methodInvocationTargetException- wraps an exception thrown by the method invokedIllegalAccessException- if the requested method is not accessible via reflection
-
invokeExactStaticMethod
public static Object invokeExactStaticMethod(Class<?> cls, String methodName, Object[] args, Class<?>[] parameterTypes) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException Invokes astaticmethod 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[]).- Parameters:
cls- invoke static method on this classmethodName- get method with this nameargs- use these arguments - treatnullas empty arrayparameterTypes- match these parameters - treatnullas empty array- Returns:
- The value returned by the invoked method
- Throws:
NoSuchMethodException- if there is no such accessible methodInvocationTargetException- wraps an exception thrown by the method invokedIllegalAccessException- if the requested method is not accessible via reflection
-
invokeMethod
public static Object invokeMethod(Object object, boolean forceAccess, String methodName) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException Invokes a named method without parameters.This is a convenient wrapper for
invokeMethod(Object object, boolean forceAccess, String methodName, Object[] args, Class[] parameterTypes).- Parameters:
object- invoke method on this objectforceAccess- force access to invoke method even if it's not accessiblemethodName- get method with this name- Returns:
- The value returned by the invoked method
- Throws:
NoSuchMethodException- if there is no such accessible methodInvocationTargetException- wraps an exception thrown by the method invokedIllegalAccessException- if the requested method is not accessible via reflection- Since:
- 3.5
-
invokeMethod
public static Object invokeMethod(Object object, boolean forceAccess, String methodName, Object... args) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException Invokes a named method whose parameter type matches the object type.This method supports calls to methods taking primitive parameters via passing in wrapping classes. So, for example, a
Booleanobject would match abooleanprimitive.This is a convenient wrapper for
invokeMethod(Object object, boolean forceAccess, String methodName, Object[] args, Class[] parameterTypes).- Parameters:
object- invoke method on this objectforceAccess- force access to invoke method even if it's not accessiblemethodName- get method with this nameargs- use these arguments - treat null as empty array- Returns:
- The value returned by the invoked method
- Throws:
NoSuchMethodException- if there is no such accessible methodInvocationTargetException- wraps an exception thrown by the method invokedIllegalAccessException- if the requested method is not accessible via reflectionNullPointerException- if the object or method name arenull- Since:
- 3.5
-
invokeMethod
public static Object invokeMethod(Object object, boolean forceAccess, String methodName, Object[] args, Class<?>[] parameterTypes) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException Invokes a named method whose parameter type matches the object type.This method supports calls to methods taking primitive parameters via passing in wrapping classes. So, for example, a
Booleanobject would match abooleanprimitive.- Parameters:
object- invoke method on this objectforceAccess- force access to invoke method even if it's not accessiblemethodName- get method with this nameargs- use these arguments - treat null as empty arrayparameterTypes- match these parameters - treat null as empty array- Returns:
- The value returned by the invoked method
- Throws:
NoSuchMethodException- if there is no such accessible methodInvocationTargetException- wraps an exception thrown by the method invokedIllegalAccessException- if the requested method is not accessible via reflectionNullPointerException- if the object or method name arenull- Since:
- 3.5
-
invokeMethod
public static Object invokeMethod(Object object, String methodName) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException Invokes a named method without parameters.This method delegates the method search to
getMatchingAccessibleMethod(Class, String, Class[]).This is a convenient wrapper for
invokeMethod(Object object, String methodName, Object[] args, Class[] parameterTypes).- Parameters:
object- invoke method on this objectmethodName- get method with this name- Returns:
- The value returned by the invoked method
- Throws:
NoSuchMethodException- if there is no such accessible methodInvocationTargetException- wraps an exception thrown by the method invokedIllegalAccessException- if the requested method is not accessible via reflection- Since:
- 3.4
-
invokeMethod
public static Object invokeMethod(Object object, String methodName, Object... args) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException Invokes a named method whose parameter type matches the object type.This method delegates the method search to
getMatchingAccessibleMethod(Class, String, Class[]).This method supports calls to methods taking primitive parameters via passing in wrapping classes. So, for example, a
Booleanobject would match abooleanprimitive.This is a convenient wrapper for
invokeMethod(Object object, String methodName, Object[] args, Class[] parameterTypes).- Parameters:
object- invoke method on this objectmethodName- get method with this nameargs- use these arguments - treat null as empty array- Returns:
- The value returned by the invoked method
- Throws:
NoSuchMethodException- if there is no such accessible methodInvocationTargetException- wraps an exception thrown by the method invokedIllegalAccessException- if the requested method is not accessible via reflectionNullPointerException- if the object or method name arenull
-
invokeMethod
public static Object invokeMethod(Object object, String methodName, Object[] args, Class<?>[] parameterTypes) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException Invokes a named method whose parameter type matches the object type.This method delegates the method search to
getMatchingAccessibleMethod(Class, String, Class[]).This method supports calls to methods taking primitive parameters via passing in wrapping classes. So, for example, a
Booleanobject would match abooleanprimitive.- Parameters:
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- Returns:
- The value returned by the invoked method
- Throws:
NoSuchMethodException- if there is no such accessible methodInvocationTargetException- wraps an exception thrown by the method invokedIllegalAccessException- if the requested method is not accessible via reflection
-
invokeStaticMethod
public static Object invokeStaticMethod(Class<?> cls, String methodName, Object... args) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException Invokes a namedstaticmethod whose parameter type matches the object type.This method delegates the method search to
getMatchingAccessibleMethod(Class, String, Class[]).This method supports calls to methods taking primitive parameters via passing in wrapping classes. So, for example, a
Booleanclass would match abooleanprimitive.This is a convenient wrapper for
invokeStaticMethod(Class, String, Object[], Class[]).- Parameters:
cls- invoke static method on this classmethodName- get method with this nameargs- use these arguments - treatnullas empty array- Returns:
- The value returned by the invoked method
- Throws:
NoSuchMethodException- if there is no such accessible methodInvocationTargetException- wraps an exception thrown by the method invokedIllegalAccessException- if the requested method is not accessible via reflection
-
invokeStaticMethod
public static Object invokeStaticMethod(Class<?> cls, String methodName, Object[] args, Class<?>[] parameterTypes) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException Invokes a namedstaticmethod whose parameter type matches the object type.This method delegates the method search to
getMatchingAccessibleMethod(Class, String, Class[]).This method supports calls to methods taking primitive parameters via passing in wrapping classes. So, for example, a
Booleanclass would match abooleanprimitive.- Parameters:
cls- invoke static method on this classmethodName- get method with this nameargs- use these arguments - treatnullas empty arrayparameterTypes- match these parameters - treatnullas empty array- Returns:
- The value returned by the invoked method
- Throws:
NoSuchMethodException- if there is no such accessible methodInvocationTargetException- wraps an exception thrown by the method invokedIllegalAccessException- if the requested method is not accessible via reflection
-