How do I invoke a Java method when given the method name as a string? How do I invoke a Java method when given the method name as a string? java java

How do I invoke a Java method when given the method name as a string?


Coding from the hip, it would be something like:

java.lang.reflect.Method method;try {  method = obj.getClass().getMethod(methodName, param1.class, param2.class, ..);} catch (SecurityException e) { ... }  catch (NoSuchMethodException e) { ... }

The parameters identify the very specific method you need (if there are several overloaded available, if the method has no arguments, only give methodName).

Then you invoke that method by calling

try {  method.invoke(obj, arg1, arg2,...);} catch (IllegalArgumentException e) { ... }  catch (IllegalAccessException e) { ... }  catch (InvocationTargetException e) { ... }

Again, leave out the arguments in .invoke, if you don't have any. But yeah. Read about Java Reflection


Use method invocation from reflection:

Class<?> c = Class.forName("class name");Method method = c.getDeclaredMethod("method name", parameterTypes);method.invoke(objectToInvokeOn, params);

Where:

  • "class name" is the name of the class
  • objectToInvokeOn is of type Object and is the object you want to invoke the method on
  • "method name" is the name of the method you want to call
  • parameterTypes is of type Class[] and declares the parameters the method takes
  • params is of type Object[] and declares the parameters to be passed to the method


For those who want a straight-forward code example in Java 7:

Dog class:

package com.mypackage.bean;public class Dog {    private String name;    private int age;    public Dog() {        // empty constructor    }    public Dog(String name, int age) {        this.name = name;        this.age = age;    }    public String getName() {        return name;    }    public void setName(String name) {        this.name = name;    }    public int getAge() {        return age;    }    public void setAge(int age) {        this.age = age;    }    public void printDog(String name, int age) {        System.out.println(name + " is " + age + " year(s) old.");    }}

ReflectionDemo class:

package com.mypackage.demo;import java.lang.reflect.*;public class ReflectionDemo {    public static void main(String[] args) throws Exception {        String dogClassName = "com.mypackage.bean.Dog";        Class<?> dogClass = Class.forName(dogClassName); // convert string classname to class        Object dog = dogClass.newInstance(); // invoke empty constructor        String methodName = "";        // with single parameter, return void        methodName = "setName";        Method setNameMethod = dog.getClass().getMethod(methodName, String.class);        setNameMethod.invoke(dog, "Mishka"); // pass arg        // without parameters, return string        methodName = "getName";        Method getNameMethod = dog.getClass().getMethod(methodName);        String name = (String) getNameMethod.invoke(dog); // explicit cast        // with multiple parameters        methodName = "printDog";        Class<?>[] paramTypes = {String.class, int.class};        Method printDogMethod = dog.getClass().getMethod(methodName, paramTypes);        printDogMethod.invoke(dog, name, 3); // pass args    }}

Output:Mishka is 3 year(s) old.


You can invoke the constructor with parameters this way:

Constructor<?> dogConstructor = dogClass.getConstructor(String.class, int.class);Object dog = dogConstructor.newInstance("Hachiko", 10);

Alternatively, you can remove

String dogClassName = "com.mypackage.bean.Dog";Class<?> dogClass = Class.forName(dogClassName);Object dog = dogClass.newInstance();

and do

Dog dog = new Dog();Method method = Dog.class.getMethod(methodName, ...);method.invoke(dog, ...);

Suggested reading: Creating New Class Instances