Package org.apache.commons.lang3.reflect

Class MethodUtils

  • public class MethodUtils
extends java.lang.Object
    Utility reflection methods focused on 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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static java.util.Comparator<java.lang.reflect.Method> METHOD_BY_SIGNATURE  

    • Constructor Summary

      Constructors 
      Constructor Description
      MethodUtils()
      Deprecated.
      TODO Make private in 4.0.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      private static int distance​(java.lang.Class<?>[] fromClassArray, java.lang.Class<?>[] toClassArray)
      Computes the aggregate number of inheritance hops between assignable argument class types.
      static java.lang.reflect.Method getAccessibleMethod​(java.lang.Class<?> cls, java.lang.reflect.Method method)
      Gets an accessible method (that is, one that can be invoked via reflection) that implements the specified Method.
      static java.lang.reflect.Method getAccessibleMethod​(java.lang.Class<?> cls, java.lang.String methodName, java.lang.Class<?>... parameterTypes)
      Gets an accessible method (that is, one that can be invoked via reflection) with given name and parameters.
      static java.lang.reflect.Method getAccessibleMethod​(java.lang.reflect.Method method)
      Gets an accessible method (that is, one that can be invoked via reflection) that implements the specified Method.
      private static java.lang.reflect.Method getAccessibleMethodFromInterfaceNest​(java.lang.Class<?> cls, java.lang.String methodName, java.lang.Class<?>... parameterTypes)
      Gets 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.
      private static java.lang.reflect.Method getAccessibleMethodFromSuperclass​(java.lang.Class<?> cls, java.lang.String methodName, java.lang.Class<?>... parameterTypes)
      Gets an accessible method (that is, one that can be invoked via reflection) by scanning through the superclasses.
      private static java.util.List<java.lang.Class<?>> getAllSuperclassesAndInterfaces​(java.lang.Class<?> cls)
      Gets a combination of ClassUtils.getAllSuperclasses(Class) and ClassUtils.getAllInterfaces(Class), one from superclasses, one from interfaces, and so on in a breadth first way.
      static <A extends java.lang.annotation.Annotation>
      A      		 getAnnotation​(java.lang.reflect.Method method, java.lang.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.
      private static java.lang.reflect.Method getInvokeMethod​(boolean forceAccess, java.lang.String methodName, java.lang.Class<?>[] parameterTypes, java.lang.Class<? extends java.lang.Object> cls)  
      static java.lang.reflect.Method getMatchingAccessibleMethod​(java.lang.Class<?> cls, java.lang.String methodName, java.lang.Class<?>... requestTypes)
      Gets an accessible method that matches the given name and has compatible parameters.
      static java.lang.reflect.Method getMatchingMethod​(java.lang.Class<?> cls, java.lang.String methodName, java.lang.Class<?>... parameterTypes)
      Gets a method whether or not it's accessible.
      static java.lang.reflect.Method getMethodObject​(java.lang.Class<?> cls, java.lang.String name, java.lang.Class<?>... parameterTypes)
      Gets a Method, or null if a documented Class.getMethod(String, Class...) exception is thrown.
      static java.util.List<java.lang.reflect.Method> getMethodsListWithAnnotation​(java.lang.Class<?> cls, java.lang.Class<? extends java.lang.annotation.Annotation> annotationCls)
      Gets all class level public methods of the given class that are annotated with the given annotation.
      static java.util.List<java.lang.reflect.Method> getMethodsListWithAnnotation​(java.lang.Class<?> cls, java.lang.Class<? extends java.lang.annotation.Annotation> annotationCls, boolean searchSupers, boolean ignoreAccess)
      Gets all methods of the given class that are annotated with the given annotation.
      static java.lang.reflect.Method[] getMethodsWithAnnotation​(java.lang.Class<?> cls, java.lang.Class<? extends java.lang.annotation.Annotation> annotationCls)
      Gets all class level public methods of the given class that are annotated with the given annotation.
      static java.lang.reflect.Method[] getMethodsWithAnnotation​(java.lang.Class<?> cls, java.lang.Class<? extends java.lang.annotation.Annotation> annotationCls, boolean searchSupers, boolean ignoreAccess)
      Gets all methods of the given class that are annotated with the given annotation.
      static java.util.Set<java.lang.reflect.Method> getOverrideHierarchy​(java.lang.reflect.Method method, ClassUtils.Interfaces interfacesBehavior)
      Gets the hierarchy of overridden methods down to result respecting generics.
      static java.lang.Object invokeExactMethod​(java.lang.Object object, java.lang.String methodName)
      Invokes a method whose parameter types match exactly the object type.
      static java.lang.Object invokeExactMethod​(java.lang.Object object, java.lang.String methodName, java.lang.Object... args)
      Invokes a method whose parameter types match exactly the object types.
      static java.lang.Object invokeExactMethod​(java.lang.Object object, java.lang.String methodName, java.lang.Object[] args, java.lang.Class<?>[] parameterTypes)
      Invokes a method whose parameter types match exactly the parameter types given.
      static java.lang.Object invokeExactStaticMethod​(java.lang.Class<?> cls, java.lang.String methodName, java.lang.Object... args)
      Invokes a static method whose parameter types match exactly the object types.
      static java.lang.Object invokeExactStaticMethod​(java.lang.Class<?> cls, java.lang.String methodName, java.lang.Object[] args, java.lang.Class<?>[] parameterTypes)
      Invokes a static method whose parameter types match exactly the parameter types given.
      static java.lang.Object invokeMethod​(java.lang.Object object, boolean forceAccess, java.lang.String methodName)
      Invokes a named method without parameters.
      static java.lang.Object invokeMethod​(java.lang.Object object, boolean forceAccess, java.lang.String methodName, java.lang.Object... args)
      Invokes a named method whose parameter type matches the object type.
      static java.lang.Object invokeMethod​(java.lang.Object object, boolean forceAccess, java.lang.String methodName, java.lang.Object[] args, java.lang.Class<?>[] parameterTypes)
      Invokes a named method whose parameter type matches the object type.
      static java.lang.Object invokeMethod​(java.lang.Object object, java.lang.String methodName)
      Invokes a named method without parameters.
      static java.lang.Object invokeMethod​(java.lang.Object object, java.lang.String methodName, java.lang.Object... args)
      Invokes a named method whose parameter type matches the object type.
      static java.lang.Object invokeMethod​(java.lang.Object object, java.lang.String methodName, java.lang.Object[] args, java.lang.Class<?>[] parameterTypes)
      Invokes a named method whose parameter type matches the object type.
      static java.lang.Object invokeStaticMethod​(java.lang.Class<?> cls, java.lang.String methodName, java.lang.Object... args)
      Invokes a named static method whose parameter type matches the object type.
      static java.lang.Object invokeStaticMethod​(java.lang.Class<?> cls, java.lang.String methodName, java.lang.Object[] args, java.lang.Class<?>[] parameterTypes)
      Invokes a named static method whose parameter type matches the object type.
      private static java.lang.reflect.Method requireNonNull​(java.lang.reflect.Method method, java.lang.Class<?> cls, java.lang.String methodName, java.lang.Class<?>[] parameterTypes)  
      private static java.lang.Object[] toVarArgs​(java.lang.Object[] args, java.lang.Class<?>[] methodParameterTypes)
      Gets an array of arguments in the canonical form, given an arguments array passed to a varargs method, for example an array with the declared number of parameters, and whose last parameter is an array of the varargs type.
      (package private) static java.lang.Object[] toVarArgs​(java.lang.reflect.Executable executable, java.lang.Object[] args)  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • METHOD_BY_SIGNATURE

        private static final java.util.Comparator<java.lang.reflect.Method> METHOD_BY_SIGNATURE

    • Constructor Detail

      • MethodUtils

        @Deprecated
public MethodUtils()
        Deprecated.
        TODO Make private in 4.0.
        MethodUtils instances should NOT be constructed in standard programming. Instead, the class should be used as MethodUtils.getAccessibleMethod(method).

        This constructor is public to permit tools that require a JavaBean instance to operate.

    • Method Detail

      • distance

        private static int distance​(java.lang.Class<?>[] fromClassArray,
                            java.lang.Class<?>[] toClassArray)
        Computes the aggregate number of inheritance hops between assignable argument class types. Returns -1 if the arguments aren't assignable. Fills a specific purpose for getMatchingMethod and is not generalized.
        Parameters:
        fromClassArray - the Class array to calculate the distance from.
        toClassArray - the Class array to calculate the distance to.
        Returns:
        the aggregate number of inheritance hops between assignable argument class types.

      • getAccessibleMethod

        public static java.lang.reflect.Method getAccessibleMethod​(java.lang.Class<?> cls,
                                                           java.lang.reflect.Method method)
        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, return null.
        Parameters:
        cls - The implementing class, may be null.
        method - The method that we wish to call, may be null.
        Returns:
        The accessible method or null.
        Since:
        3.19.0

      • getAccessibleMethod

        public static java.lang.reflect.Method getAccessibleMethod​(java.lang.Class<?> cls,
                                                           java.lang.String methodName,
                                                           java.lang.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, return null. This is just a convenience wrapper for getAccessibleMethod(Method).
        Parameters:
        cls - get method from this class.
        methodName - get method with this name.
        parameterTypes - with these parameters types.
        Returns:
        The accessible method.

      • getAccessibleMethod

        public static java.lang.reflect.Method getAccessibleMethod​(java.lang.reflect.Method method)
        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, return null.
        Parameters:
        method - The method that we wish to call, may be null.
        Returns:
        The accessible method

      • getAccessibleMethodFromInterfaceNest

        private static java.lang.reflect.Method getAccessibleMethodFromInterfaceNest​(java.lang.Class<?> cls,
                                                                             java.lang.String methodName,
                                                                             java.lang.Class<?>... parameterTypes)
        Gets 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:
        cls - Parent class for the interfaces to be checked
        methodName - Method name of the method we wish to call
        parameterTypes - The parameter type signatures
        Returns:
        the accessible method or null if not found

      • getAccessibleMethodFromSuperclass

        private static java.lang.reflect.Method getAccessibleMethodFromSuperclass​(java.lang.Class<?> cls,
                                                                          java.lang.String methodName,
                                                                          java.lang.Class<?>... parameterTypes)
        Gets 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.
        Parameters:
        cls - Class to be checked.
        methodName - Method name of the method we wish to call.
        parameterTypes - The parameter type signatures.
        Returns:
        the accessible method or null if not found.

      • getAllSuperclassesAndInterfaces

        private static java.util.List<java.lang.Class<?>> getAllSuperclassesAndInterfaces​(java.lang.Class<?> cls)
        Gets a combination of ClassUtils.getAllSuperclasses(Class) and ClassUtils.getAllInterfaces(Class), one from superclasses, one from interfaces, and so on in a breadth first way.
        Parameters:
        cls - the class to look up, may be null
        Returns:
        the combined List of superclasses and interfaces in order going up from this one null if null input

      • getAnnotation

        public static <A extends java.lang.annotation.Annotation> A getAnnotation​(java.lang.reflect.Method method,
                                                                          java.lang.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 - the Method to query, may be null.
        annotationCls - the Annotation to check if is present on the method
        searchSupers - determines if a lookup in the entire inheritance hierarchy of the given class is performed if the annotation was not directly present
        ignoreAccess - determines if underlying method has to be accessible
        Returns:
        the first matching annotation, or null if not found
        Throws:
        java.lang.NullPointerException - if either the method or annotation class is null
        java.lang.SecurityException - if an underlying accessible object's method denies the request.
        Since:
        3.6
        See Also:
        SecurityManager.checkPermission(java.security.Permission)

      • getInvokeMethod

        private static java.lang.reflect.Method getInvokeMethod​(boolean forceAccess,
                                                        java.lang.String methodName,
                                                        java.lang.Class<?>[] parameterTypes,
                                                        java.lang.Class<? extends java.lang.Object> cls)

      • getMatchingAccessibleMethod

        public static java.lang.reflect.Method getMatchingAccessibleMethod​(java.lang.Class<?> cls,
                                                                   java.lang.String methodName,
                                                                   java.lang.Class<?>... requestTypes)
        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 Boolean will match a primitive boolean parameter.

        Parameters:
        cls - find method in this class.
        methodName - find method with this name.
        requestTypes - find method with most compatible parameters.
        Returns:
        The accessible method or null.
        Throws:
        java.lang.SecurityException - if an underlying accessible object's method denies the request.
        See Also:
        SecurityManager.checkPermission(java.security.Permission)

      • getMatchingMethod

        public static java.lang.reflect.Method getMatchingMethod​(java.lang.Class<?> cls,
                                                         java.lang.String methodName,
                                                         java.lang.Class<?>... parameterTypes)
        Gets a method whether or not it's accessible. If no such method can be found, return null.
        Parameters:
        cls - The class that will be subjected to the method search
        methodName - The method that we wish to call
        parameterTypes - Argument class types
        Returns:
        The method
        Throws:
        java.lang.IllegalStateException - if there is no unique result
        java.lang.NullPointerException - if the class is null
        Since:
        3.5

      • getMethodObject

        public static java.lang.reflect.Method getMethodObject​(java.lang.Class<?> cls,
                                                       java.lang.String name,
                                                       java.lang.Class<?>... parameterTypes)
        Gets a Method, or null if a documented Class.getMethod(String, Class...) exception is thrown.
        Parameters:
        cls - Receiver for Class.getMethod(String, Class...).
        name - the name of the method.
        parameterTypes - the list of parameters.
        Returns:
        a Method or null.
        Since:
        3.15.0
        See Also:
        SecurityManager.checkPermission(java.security.Permission), Class.getMethod(String, Class...)

      • getMethodsListWithAnnotation

        public static java.util.List<java.lang.reflect.Method> getMethodsListWithAnnotation​(java.lang.Class<?> cls,
                                                                                    java.lang.Class<? extends java.lang.annotation.Annotation> annotationCls)
        Gets all class level public methods of the given class that are annotated with the given annotation.
        Parameters:
        cls - the Class to query
        annotationCls - the Annotation that must be present on a method to be matched
        Returns:
        a list of Methods (possibly empty).
        Throws:
        java.lang.NullPointerException - if the class or annotation are null
        Since:
        3.4

      • getMethodsListWithAnnotation

        public static java.util.List<java.lang.reflect.Method> getMethodsListWithAnnotation​(java.lang.Class<?> cls,
                                                                                    java.lang.Class<? extends java.lang.annotation.Annotation> annotationCls,
                                                                                    boolean searchSupers,
                                                                                    boolean ignoreAccess)
        Gets all methods of the given class that are annotated with the given annotation.
        Parameters:
        cls - the Class to query
        annotationCls - the Annotation that must be present on a method to be matched
        searchSupers - determines if a lookup in the entire inheritance hierarchy of the given class should be performed
        ignoreAccess - determines if non-public methods should be considered
        Returns:
        a list of Methods (possibly empty).
        Throws:
        java.lang.NullPointerException - if either the class or annotation class is null
        Since:
        3.6

      • getMethodsWithAnnotation

        public static java.lang.reflect.Method[] getMethodsWithAnnotation​(java.lang.Class<?> cls,
                                                                  java.lang.Class<? extends java.lang.annotation.Annotation> annotationCls)
        Gets all class level public methods of the given class that are annotated with the given annotation.
        Parameters:
        cls - the Class to query
        annotationCls - the Annotation that must be present on a method to be matched
        Returns:
        an array of Methods (possibly empty).
        Throws:
        java.lang.NullPointerException - if the class or annotation are null
        Since:
        3.4

      • getMethodsWithAnnotation

        public static java.lang.reflect.Method[] getMethodsWithAnnotation​(java.lang.Class<?> cls,
                                                                  java.lang.Class<? extends java.lang.annotation.Annotation> annotationCls,
                                                                  boolean searchSupers,
                                                                  boolean ignoreAccess)
        Gets all methods of the given class that are annotated with the given annotation.
        Parameters:
        cls - the Class to query
        annotationCls - the Annotation that must be present on a method to be matched
        searchSupers - determines if a lookup in the entire inheritance hierarchy of the given class should be performed
        ignoreAccess - determines if non-public methods should be considered
        Returns:
        an array of Methods (possibly empty).
        Throws:
        java.lang.NullPointerException - if the class or annotation are null
        Since:
        3.6

      • getOverrideHierarchy

        public static java.util.Set<java.lang.reflect.Method> getOverrideHierarchy​(java.lang.reflect.Method method,
                                                                           ClassUtils.Interfaces interfacesBehavior)
        Gets the hierarchy of overridden methods down to result respecting generics.
        Parameters:
        method - lowest to consider
        interfacesBehavior - whether to search interfaces, null implies false
        Returns:
        a Set<Method> in ascending order from subclass to superclass
        Throws:
        java.lang.NullPointerException - if the specified method is null
        java.lang.SecurityException - if an underlying accessible object's method denies the request.
        Since:
        3.2
        See Also:
        SecurityManager.checkPermission(java.security.Permission)

      • invokeExactMethod

        public static java.lang.Object invokeExactMethod​(java.lang.Object object,
                                                 java.lang.String methodName)
                                          throws java.lang.NoSuchMethodException,
                                                 java.lang.IllegalAccessException,
                                                 java.lang.reflect.InvocationTargetException
        Invokes a method whose parameter types match exactly the object type.

        This uses reflection to invoke the method obtained from a call to getAccessibleMethod(Class, String, Class[]).

        Parameters:
        object - invoke method on this object.
        methodName - get method with this name.
        Returns:
        The value returned by the invoked method.
        Throws:
        java.lang.NoSuchMethodException - Thrown if there is no such accessible method.
        java.lang.IllegalAccessException - Thrown if this found Method is enforcing Java language access control and the underlying method is inaccessible.
        java.lang.IllegalArgumentException - Thrown if:
        • the found Method is an instance method and the specified object argument is not an instance of the class or interface declaring the underlying method (or of a subclass or interface implementor);
        • the number of actual and formal parameters differ;
        java.lang.reflect.InvocationTargetException - Thrown if the underlying method throws an exception.
        java.lang.NullPointerException - Thrown if the specified object is null.
        java.lang.ExceptionInInitializerError - Thrown if the initialization provoked by this method fails.
        Since:
        3.4

      • invokeExactMethod

        public static java.lang.Object invokeExactMethod​(java.lang.Object object,
                                                 java.lang.String methodName,
                                                 java.lang.Object... args)
                                          throws java.lang.NoSuchMethodException,
                                                 java.lang.IllegalAccessException,
                                                 java.lang.reflect.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(Class, String, Class[]).

        Parameters:
        object - invoke method on this object.
        methodName - get method with this name.
        args - use these arguments - treat null as empty array.
        Returns:
        The value returned by the invoked method.
        Throws:
        java.lang.NoSuchMethodException - Thrown if there is no such accessible method.
        java.lang.IllegalAccessException - Thrown if this found Method is enforcing Java language access control and the underlying method is inaccessible.
        java.lang.IllegalArgumentException - Thrown if:
        • the found Method is an instance method and the specified object argument is not an instance of the class or interface declaring the underlying method (or of a subclass or interface implementor);
        • the number of actual and formal parameters differ;
        • an unwrapping conversion for primitive arguments fails; or
        • after possible unwrapping, a parameter value can't be converted to the corresponding formal parameter type by a method invocation conversion.
        java.lang.reflect.InvocationTargetException - Thrown if the underlying method throws an exception.
        java.lang.NullPointerException - Thrown if the specified object is null.
        java.lang.ExceptionInInitializerError - Thrown if the initialization provoked by this method fails.

      • invokeExactMethod

        public static java.lang.Object invokeExactMethod​(java.lang.Object object,
                                                 java.lang.String methodName,
                                                 java.lang.Object[] args,
                                                 java.lang.Class<?>[] parameterTypes)
                                          throws java.lang.NoSuchMethodException,
                                                 java.lang.IllegalAccessException,
                                                 java.lang.reflect.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 - Invokes a method on this object.
        methodName - Gets a method with this name.
        args - Method arguments - treat null as empty array.
        parameterTypes - Match these parameters - treat null as empty array.
        Returns:
        The value returned by the invoked method.
        Throws:
        java.lang.NoSuchMethodException - Thrown if there is no such accessible method.
        java.lang.IllegalAccessException - Thrown if this found Method is enforcing Java language access control and the underlying method is inaccessible.
        java.lang.IllegalArgumentException - Thrown if:
        • the found Method is an instance method and the specified object argument is not an instance of the class or interface declaring the underlying method (or of a subclass or interface implementor);
        • the number of actual and formal parameters differ;
        • an unwrapping conversion for primitive arguments fails; or
        • after possible unwrapping, a parameter value can't be converted to the corresponding formal parameter type by a method invocation conversion.
        java.lang.reflect.InvocationTargetException - Thrown if the underlying method throws an exception.
        java.lang.NullPointerException - Thrown if the specified object is null.
        java.lang.ExceptionInInitializerError - Thrown if the initialization provoked by this method fails.

      • invokeExactStaticMethod

        public static java.lang.Object invokeExactStaticMethod​(java.lang.Class<?> cls,
                                                       java.lang.String methodName,
                                                       java.lang.Object... args)
                                                throws java.lang.NoSuchMethodException,
                                                       java.lang.IllegalAccessException,
                                                       java.lang.reflect.InvocationTargetException
        Invokes 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[]).

        Parameters:
        cls - invoke static method on this class
        methodName - get method with this name
        args - use these arguments - treat null as empty array
        Returns:
        The value returned by the invoked method
        Throws:
        java.lang.NoSuchMethodException - Thrown if there is no such accessible method.
        java.lang.IllegalAccessException - Thrown if this found Method is enforcing Java language access control and the underlying method is inaccessible.
        java.lang.IllegalArgumentException - Thrown if:
        • the found Method is an instance method and the specified object argument is not an instance of the class or interface declaring the underlying method (or of a subclass or interface implementor);
        • the number of actual and formal parameters differ;
        • an unwrapping conversion for primitive arguments fails; or
        • after possible unwrapping, a parameter value can't be converted to the corresponding formal parameter type by a method invocation conversion.
        java.lang.reflect.InvocationTargetException - Thrown if the underlying method throws an exception.
        java.lang.ExceptionInInitializerError - Thrown if the initialization provoked by this method fails.

      • invokeExactStaticMethod

        public static java.lang.Object invokeExactStaticMethod​(java.lang.Class<?> cls,
                                                       java.lang.String methodName,
                                                       java.lang.Object[] args,
                                                       java.lang.Class<?>[] parameterTypes)
                                                throws java.lang.NoSuchMethodException,
                                                       java.lang.IllegalAccessException,
                                                       java.lang.reflect.InvocationTargetException
        Invokes 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[]).

        Parameters:
        cls - invoke static method on this class
        methodName - get method with this name
        args - use these arguments - treat null as empty array
        parameterTypes - match these parameters - treat null as empty array
        Returns:
        The value returned by the invoked method
        Throws:
        java.lang.NoSuchMethodException - Thrown if there is no such accessible method.
        java.lang.IllegalAccessException - Thrown if this found Method is enforcing Java language access control and the underlying method is inaccessible.
        java.lang.IllegalArgumentException - Thrown if:
        • the found Method is an instance method and the specified object argument is not an instance of the class or interface declaring the underlying method (or of a subclass or interface implementor);
        • the number of actual and formal parameters differ;
        • an unwrapping conversion for primitive arguments fails; or
        • after possible unwrapping, a parameter value can't be converted to the corresponding formal parameter type by a method invocation conversion.
        java.lang.reflect.InvocationTargetException - Thrown if the underlying method throws an exception.
        java.lang.ExceptionInInitializerError - Thrown if the initialization provoked by this method fails.

      • invokeMethod

        public static java.lang.Object invokeMethod​(java.lang.Object object,
                                            boolean forceAccess,
                                            java.lang.String methodName)
                                     throws java.lang.NoSuchMethodException,
                                            java.lang.IllegalAccessException,
                                            java.lang.reflect.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 object
        forceAccess - force access to invoke method even if it's not accessible
        methodName - get method with this name
        Returns:
        The value returned by the invoked method
        Throws:
        java.lang.NoSuchMethodException - Thrown if there is no such accessible method.
        java.lang.IllegalAccessException - Thrown if this found Method is enforcing Java language access control and the underlying method is inaccessible.
        java.lang.IllegalArgumentException - Thrown if:
        • the found Method is an instance method and the specified object argument is not an instance of the class or interface declaring the underlying method (or of a subclass or interface implementor);
        • the number of actual and formal parameters differ;
        • an unwrapping conversion for primitive arguments fails; or
        • after possible unwrapping, a parameter value can't be converted to the corresponding formal parameter type by a method invocation conversion.
        java.lang.reflect.InvocationTargetException - Thrown if the underlying method throws an exception.
        java.lang.NullPointerException - Thrown if the specified object is null.
        java.lang.ExceptionInInitializerError - Thrown if the initialization provoked by this method fails.
        Since:
        3.5
        See Also:
        SecurityManager.checkPermission(java.security.Permission)

      • invokeMethod

        public static java.lang.Object invokeMethod​(java.lang.Object object,
                                            boolean forceAccess,
                                            java.lang.String methodName,
                                            java.lang.Object... args)
                                     throws java.lang.NoSuchMethodException,
                                            java.lang.IllegalAccessException,
                                            java.lang.reflect.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 Boolean object would match a boolean primitive.

        This is a convenient wrapper for invokeMethod(Object object, boolean forceAccess, String methodName, Object[] args, Class[] parameterTypes).

        Parameters:
        object - invoke method on this object
        forceAccess - force access to invoke method even if it's not accessible
        methodName - get method with this name
        args - use these arguments - treat null as empty array
        Returns:
        The value returned by the invoked method
        Throws:
        java.lang.NoSuchMethodException - Thrown if there is no such accessible method.
        java.lang.IllegalAccessException - Thrown if this found Method is enforcing Java language access control and the underlying method is inaccessible.
        java.lang.IllegalArgumentException - Thrown if:
        • the found Method is an instance method and the specified object argument is not an instance of the class or interface declaring the underlying method (or of a subclass or interface implementor);
        • the number of actual and formal parameters differ;
        • an unwrapping conversion for primitive arguments fails; or
        • after possible unwrapping, a parameter value can't be converted to the corresponding formal parameter type by a method invocation conversion.
        java.lang.reflect.InvocationTargetException - Thrown if the underlying method throws an exception.
        java.lang.NullPointerException - Thrown if the specified object is null.
        java.lang.ExceptionInInitializerError - Thrown if the initialization provoked by this method fails.
        Since:
        3.5
        See Also:
        SecurityManager.checkPermission(java.security.Permission)

      • invokeMethod

        public static java.lang.Object invokeMethod​(java.lang.Object object,
                                            boolean forceAccess,
                                            java.lang.String methodName,
                                            java.lang.Object[] args,
                                            java.lang.Class<?>[] parameterTypes)
                                     throws java.lang.NoSuchMethodException,
                                            java.lang.IllegalAccessException,
                                            java.lang.reflect.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 Boolean object would match a boolean primitive.

        Parameters:
        object - invoke method on this object
        forceAccess - force access to invoke method even if it's not accessible
        methodName - get method with this name
        args - use these arguments - treat null as empty array
        parameterTypes - match these parameters - treat null as empty array
        Returns:
        The value returned by the invoked method
        Throws:
        java.lang.NoSuchMethodException - Thrown if there is no such accessible method.
        java.lang.IllegalAccessException - Thrown if this found Method is enforcing Java language access control and the underlying method is inaccessible.
        java.lang.IllegalArgumentException - Thrown if:
        • the found Method is an instance method and the specified object argument is not an instance of the class or interface declaring the underlying method (or of a subclass or interface implementor);
        • the number of actual and formal parameters differ;
        • an unwrapping conversion for primitive arguments fails; or
        • after possible unwrapping, a parameter value can't be converted to the corresponding formal parameter type by a method invocation conversion.
        java.lang.reflect.InvocationTargetException - Thrown if the underlying method throws an exception.
        java.lang.NullPointerException - Thrown if the specified object is null.
        java.lang.ExceptionInInitializerError - Thrown if the initialization provoked by this method fails.
        Since:
        3.5
        See Also:
        SecurityManager.checkPermission(java.security.Permission)

      • invokeMethod

        public static java.lang.Object invokeMethod​(java.lang.Object object,
                                            java.lang.String methodName)
                                     throws java.lang.NoSuchMethodException,
                                            java.lang.IllegalAccessException,
                                            java.lang.reflect.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 object
        methodName - get method with this name
        Returns:
        The value returned by the invoked method
        Throws:
        java.lang.NoSuchMethodException - if there is no such accessible method
        java.lang.reflect.InvocationTargetException - wraps an exception thrown by the method invoked
        java.lang.IllegalAccessException - if the requested method is not accessible via reflection
        java.lang.SecurityException - if an underlying accessible object's method denies the request.
        Since:
        3.4
        See Also:
        SecurityManager.checkPermission(java.security.Permission)

      • invokeMethod

        public static java.lang.Object invokeMethod​(java.lang.Object object,
                                            java.lang.String methodName,
                                            java.lang.Object... args)
                                     throws java.lang.NoSuchMethodException,
                                            java.lang.IllegalAccessException,
                                            java.lang.reflect.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 Boolean object would match a boolean primitive.

        This is a convenient wrapper for 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
        Returns:
        The value returned by the invoked method
        Throws:
        java.lang.NoSuchMethodException - if there is no such accessible method
        java.lang.reflect.InvocationTargetException - wraps an exception thrown by the method invoked
        java.lang.IllegalAccessException - if the requested method is not accessible via reflection
        java.lang.NullPointerException - if the object or method name are null
        java.lang.SecurityException - if an underlying accessible object's method denies the request.
        See Also:
        SecurityManager.checkPermission(java.security.Permission)

      • invokeMethod

        public static java.lang.Object invokeMethod​(java.lang.Object object,
                                            java.lang.String methodName,
                                            java.lang.Object[] args,
                                            java.lang.Class<?>[] parameterTypes)
                                     throws java.lang.NoSuchMethodException,
                                            java.lang.IllegalAccessException,
                                            java.lang.reflect.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 Boolean object 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
        Returns:
        The value returned by the invoked method
        Throws:
        java.lang.NoSuchMethodException - Thrown if there is no such accessible method.
        java.lang.IllegalAccessException - Thrown if this found Method is enforcing Java language access control and the underlying method is inaccessible.
        java.lang.IllegalArgumentException - Thrown if:
        • the found Method is an instance method and the specified object argument is not an instance of the class or interface declaring the underlying method (or of a subclass or interface implementor);
        • the number of actual and formal parameters differ;
        • an unwrapping conversion for primitive arguments fails; or
        • after possible unwrapping, a parameter value can't be converted to the corresponding formal parameter type by a method invocation conversion.
        java.lang.reflect.InvocationTargetException - Thrown if the underlying method throws an exception.
        java.lang.NullPointerException - Thrown if the specified object is null.
        java.lang.ExceptionInInitializerError - Thrown if the initialization provoked by this method fails.
        See Also:
        SecurityManager.checkPermission(java.security.Permission)

      • invokeStaticMethod

        public static java.lang.Object invokeStaticMethod​(java.lang.Class<?> cls,
                                                  java.lang.String methodName,
                                                  java.lang.Object... args)
                                           throws java.lang.NoSuchMethodException,
                                                  java.lang.IllegalAccessException,
                                                  java.lang.reflect.InvocationTargetException
        Invokes a named static 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 Boolean class would match a boolean primitive.

        This is a convenient wrapper for invokeStaticMethod(Class, String, Object[], Class[]).

        Parameters:
        cls - invoke static method on this class
        methodName - get method with this name
        args - use these arguments - treat null as empty array
        Returns:
        The value returned by the invoked method
        Throws:
        java.lang.NoSuchMethodException - Thrown if there is no such accessible method.
        java.lang.IllegalAccessException - Thrown if this found Method is enforcing Java language access control and the underlying method is inaccessible.
        java.lang.IllegalArgumentException - Thrown if:
        • the found Method is an instance method and the specified object argument is not an instance of the class or interface declaring the underlying method (or of a subclass or interface implementor);
        • the number of actual and formal parameters differ;
        • an unwrapping conversion for primitive arguments fails; or
        • after possible unwrapping, a parameter value can't be converted to the corresponding formal parameter type by a method invocation conversion.
        java.lang.reflect.InvocationTargetException - Thrown if the underlying method throws an exception.
        java.lang.ExceptionInInitializerError - Thrown if the initialization provoked by this method fails.
        See Also:
        SecurityManager.checkPermission(java.security.Permission)

      • invokeStaticMethod

        public static java.lang.Object invokeStaticMethod​(java.lang.Class<?> cls,
                                                  java.lang.String methodName,
                                                  java.lang.Object[] args,
                                                  java.lang.Class<?>[] parameterTypes)
                                           throws java.lang.NoSuchMethodException,
                                                  java.lang.IllegalAccessException,
                                                  java.lang.reflect.InvocationTargetException
        Invokes a named static 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 Boolean class would match a boolean primitive.

        Parameters:
        cls - invoke static method on this class
        methodName - get method with this name
        args - use these arguments - treat null as empty array
        parameterTypes - match these parameters - treat null as empty array
        Returns:
        The value returned by the invoked method
        Throws:
        java.lang.NoSuchMethodException - Thrown if there is no such accessible method.
        java.lang.IllegalAccessException - Thrown if this found Method is enforcing Java language access control and the underlying method is inaccessible.
        java.lang.IllegalArgumentException - Thrown if:
        • the found Method is an instance method and the specified object argument is not an instance of the class or interface declaring the underlying method (or of a subclass or interface implementor);
        • the number of actual and formal parameters differ;
        • an unwrapping conversion for primitive arguments fails; or
        • after possible unwrapping, a parameter value can't be converted to the corresponding formal parameter type by a method invocation conversion.
        java.lang.reflect.InvocationTargetException - Thrown if the underlying method throws an exception.
        java.lang.ExceptionInInitializerError - Thrown if the initialization provoked by this method fails.
        See Also:
        SecurityManager.checkPermission(java.security.Permission)

      • requireNonNull

        private static java.lang.reflect.Method requireNonNull​(java.lang.reflect.Method method,
                                                       java.lang.Class<?> cls,
                                                       java.lang.String methodName,
                                                       java.lang.Class<?>[] parameterTypes)
                                                throws java.lang.NoSuchMethodException
        Throws:
        java.lang.NoSuchMethodException

      • toVarArgs

        static java.lang.Object[] toVarArgs​(java.lang.reflect.Executable executable,
                                    java.lang.Object[] args)
                             throws java.lang.IllegalAccessException,
                                    java.lang.reflect.InvocationTargetException,
                                    java.lang.NoSuchMethodException
        Throws:
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
        java.lang.NoSuchMethodException

      • toVarArgs

        private static java.lang.Object[] toVarArgs​(java.lang.Object[] args,
                                            java.lang.Class<?>[] methodParameterTypes)
                                     throws java.lang.IllegalAccessException,
                                            java.lang.reflect.InvocationTargetException,
                                            java.lang.NoSuchMethodException
        Gets an array of arguments in the canonical form, given an arguments array passed to a varargs method, for example an array with the declared number of parameters, and whose last parameter is an array of the varargs type.

        We follow the JLS 5.1.2. Widening Primitive Conversion rules.

        Parameters:
        args - the array of arguments passed to the varags method.
        methodParameterTypes - the declared array of method parameter types.
        Returns:
        an array of the variadic arguments passed to the method.
        Throws:
        java.lang.NoSuchMethodException - Thrown if the constructor could not be found.
        java.lang.IllegalAccessException - Thrown if this Constructor object is enforcing Java language access control and the underlying constructor is inaccessible.
        java.lang.IllegalArgumentException - Thrown if the number of actual and formal parameters differ; if an unwrapping conversion for primitive arguments fails; or if, after possible unwrapping, a parameter value cannot be converted to the corresponding formal parameter type by a method invocation conversion; if this constructor pertains to an enum type.
        java.lang.InstantiationException - Thrown if a class that declares the underlying constructor represents an abstract class.
        java.lang.reflect.InvocationTargetException - Thrown if an underlying constructor throws an exception.
        java.lang.ExceptionInInitializerError - Thrown if an initialization provoked by this method fails.
        See Also:
        JLS 5.1.2. Widening Primitive Conversion