Save This Page
Home » spring-framework-2.5.6-with-dependencies » org.springframework » util » [javadoc | source]
org.springframework.util
public class: MethodInvoker [javadoc | source]
java.lang.Object
   org.springframework.util.MethodInvoker

Direct Known Subclasses:
    MethodInvokingJobDetailFactoryBean, ArgumentConvertingMethodInvoker, MethodInvokingRunnable, MethodInvokingFactoryBean, MethodInvokingTimerTaskFactoryBean

Helper class that allows for specifying a method to invoke in a declarative fashion, be it static or non-static.

Usage: Specify "targetClass"/"targetMethod" or "targetObject"/"targetMethod", optionally specify arguments, prepare the invoker. Afterwards, you may invoke the method any number of times, obtaining the invocation result.

Typically not used directly but via its subclasses org.springframework.beans.factory.config.MethodInvokingFactoryBean and org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean .

Method from org.springframework.util.MethodInvoker Summary:
findMatchingMethod,   getArguments,   getPreparedMethod,   getTargetClass,   getTargetMethod,   getTargetObject,   getTypeDifferenceWeight,   invoke,   isPrepared,   prepare,   resolveClassName,   setArguments,   setStaticMethod,   setTargetClass,   setTargetMethod,   setTargetObject
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.springframework.util.MethodInvoker Detail:
 protected Method findMatchingMethod() 
    Find a matching method with the specified name for the specified arguments.
 public Object[] getArguments() 
    Return the arguments for the method invocation.
 public Method getPreparedMethod() throws IllegalStateException 
    Return the prepared Method object that will be invoked.

    Can for example be used to determine the return type.

 public Class getTargetClass() 
    Return the target class on which to call the target method.
 public String getTargetMethod() 
    Return the name of the method to be invoked.
 public Object getTargetObject() 
    Return the target object on which to call the target method.
 public static int getTypeDifferenceWeight(Class[] paramTypes,
    Object[] args) 
    Algorithm that judges the match between the declared parameter types of a candidate method and a specific list of arguments that this method is supposed to be invoked with.

    Determines a weight that represents the class hierarchy difference between types and arguments. A direct match, i.e. type Integer -> arg of class Integer, does not increase the result - all direct matches means weight 0. A match between type Object and arg of class Integer would increase the weight by 2, due to the superclass 2 steps up in the hierarchy (i.e. Object) being the last one that still matches the required type Object. Type Number and class Integer would increase the weight by 1 accordingly, due to the superclass 1 step up the hierarchy (i.e. Number) still matching the required type Number. Therefore, with an arg of type Integer, a constructor (Integer) would be preferred to a constructor (Number) which would in turn be preferred to a constructor (Object). All argument weights get accumulated.

 public Object invoke() throws InvocationTargetException, IllegalAccessException 
    Invoke the specified method.

    The invoker needs to have been prepared before.

 public boolean isPrepared() 
    Return whether this invoker has been prepared already, i.e. whether it allows access to #getPreparedMethod() already.
 public  void prepare() throws ClassNotFoundException, NoSuchMethodException 
    Prepare the specified method. The method can be invoked any number of times afterwards.
 protected Class resolveClassName(String className) throws ClassNotFoundException 
    Resolve the given class name into a Class.

    The default implementations uses ClassUtils.forName, using the thread context class loader.

 public  void setArguments(Object[] arguments) 
    Set arguments for the method invocation. If this property is not set, or the Object array is of length 0, a method with no arguments is assumed.
 public  void setStaticMethod(String staticMethod) 
    Set a fully qualified static method name to invoke, e.g. "example.MyExampleClass.myExampleMethod". Convenient alternative to specifying targetClass and targetMethod.
 public  void setTargetClass(Class targetClass) 
    Set the target class on which to call the target method. Only necessary when the target method is static; else, a target object needs to be specified anyway.
 public  void setTargetMethod(String targetMethod) 
    Set the name of the method to be invoked. Refers to either a static method or a non-static method, depending on a target object being set.
 public  void setTargetObject(Object targetObject) 
    Set the target object on which to call the target method. Only necessary when the target method is not static; else, a target class is sufficient.