org.kunlab.kpm.utils

Class ReflectionUtils

java.lang.Object

org.kunlab.kpm.utils.ReflectionUtils

public final class ReflectionUtils
extends Object

ReflectionUtils

This class provides useful methods which makes dealing with reflection much easier, especially when working with Bukkit

You are welcome to use it, modify it and redistribute it under the following conditions:

• Don't claim this class as your own
• Don't remove this disclaimer

It would be nice if you provide credit to me if you use this class in a published project

Version:

1.1-PYG

Author:

DarkBlade12, Peyang

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReflectionUtils.DataType Represents an enumeration of Java data types with corresponding classes
static class	ReflectionUtils.PackageType Represents an enumeration of dynamic packages of NMS and CraftBukkit

Constructor Summary

Constructors

Constructor and Description
ReflectionUtils()

Method Summary

Modifier and Type	Method and Description
static Constructor<?>	getAccessibleConstructor(Class<?> clazz, Class<?>... parameterTypes) Returns the accessible constructor of a desired class with the given parameter types
static Constructor<?>	getAccessibleConstructor(String className, ReflectionUtils.PackageType packageType, Class<?>... parameterTypes) Returns the accessible constructor of a desired class with the given parameter types
static Field	getAccessibleField(Class<?> clazz, boolean declared, String fieldName) Returns an accessible field of the target class with the given name
static Field	getAccessibleField(String className, ReflectionUtils.PackageType packageType, boolean declared, String fieldName) Returns an accessible field of a desired class with the given name
static Method	getAccessibleMethod(Class<?> clazz, String methodName, Class<?>... parameterTypes) Returns an accessible method of a class with the given parameter types
static Method	getAccessibleMethod(String className, ReflectionUtils.PackageType packageType, String methodName, Class<?>... parameterTypes) Returns an accessible method of a desired class with the given parameter types
static Constructor<?>	getConstructor(Class<?> clazz, Class<?>... parameterTypes) Returns the constructor of a given class with the given parameter types
static Constructor<?>	getConstructor(String className, ReflectionUtils.PackageType packageType, Class<?>... parameterTypes) Returns the constructor of a desired class with the given parameter types
static Field	getField(Class<?> clazz, boolean declared, String fieldName) Returns a field of the target class with the given name
static Field	getField(String className, ReflectionUtils.PackageType packageType, boolean declared, String fieldName) Returns a field of a desired class with the given name
static Method	getMethod(Class<?> clazz, String methodName, Class<?>... parameterTypes) Returns a method of a class with the given parameter types
static Method	getMethod(String className, ReflectionUtils.PackageType packageType, String methodName, Class<?>... parameterTypes) Returns a method of a desired class with the given parameter types
static Object	getValue(Object instance, boolean declared, String fieldName) Returns the value of a field with the given name of an object
static Object	getValue(Object instance, Class<?> clazz, boolean declared, String fieldName) Returns the value of a field of the given class of an object
static Object	getValue(Object instance, String className, ReflectionUtils.PackageType packageType, boolean declared, String fieldName) Returns the value of a field of a desired class of an object
static Object	instantiateObject(Class<?> clazz, Object... arguments) Returns an instance of a class with the given arguments
static Object	instantiateObject(String className, ReflectionUtils.PackageType packageType, Object... arguments) Returns an instance of a desired class with the given arguments
static Object	invokeMethod(Object instance, Class<?> clazz, String methodName, Object... arguments) Invokes a method of the target class on an object with the given arguments
static Object	invokeMethod(Object instance, String methodName, Object... arguments) Invokes a method on an object with the given arguments
static Object	invokeMethod(Object instance, String className, ReflectionUtils.PackageType packageType, String methodName, Object... arguments) Invokes a method of a desired class on an object with the given arguments
static void	setValue(Object instance, boolean declared, String fieldName, Object value) Sets the value of a field with the given name of an object
static void	setValue(Object instance, Class<?> clazz, boolean declared, String fieldName, Object value) Sets the value of a field of the given class of an object
static void	setValue(Object instance, String className, ReflectionUtils.PackageType packageType, boolean declared, String fieldName, Object value) Sets the value of a field of a desired class of an object

Methods inherited from class java.lang.Object

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

Constructor Detail

ReflectionUtils

public ReflectionUtils()

Method Detail

getConstructor

public static Constructor<?> getConstructor(Class<?> clazz,
                                            Class<?>... parameterTypes)
                                     throws NoSuchMethodException

Returns the constructor of a given class with the given parameter types

Parameters:

clazz - Target class

parameterTypes - Parameter types of the desired constructor

Returns:

The constructor of the target class with the specified parameter types

Throws:

NoSuchMethodException - If the desired constructor with the specified parameter types cannot be found

See Also:

ReflectionUtils.DataType, ReflectionUtils.DataType.getPrimitive(Class[]), ReflectionUtils.DataType.compare(Class[], Class[])

getConstructor

public static Constructor<?> getConstructor(String className,
                                            ReflectionUtils.PackageType packageType,
                                            Class<?>... parameterTypes)
                                     throws NoSuchMethodException,
                                            ClassNotFoundException

Returns the constructor of a desired class with the given parameter types

Parameters:

className - Name of the desired target class

packageType - Package where the desired target class is located

parameterTypes - Parameter types of the desired constructor

Returns:

The constructor of the desired target class with the specified parameter types

Throws:

NoSuchMethodException - If the desired constructor with the specified parameter types cannot be found

ClassNotFoundException - If the desired target class with the specified name and package cannot be found

See Also:

getConstructor(Class, Class...)

getAccessibleConstructor

public static Constructor<?> getAccessibleConstructor(Class<?> clazz,
                                                      Class<?>... parameterTypes)
                                               throws NoSuchMethodException

Returns the accessible constructor of a desired class with the given parameter types

Parameters:

clazz - Target class

parameterTypes - Parameter types of the desired constructor

Returns:

The accessible constructor of the target class with the specified parameter types

Throws:

NoSuchMethodException - If the desired constructor with the specified parameter types cannot be found

See Also:

ReflectionUtils.DataType, ReflectionUtils.DataType.getPrimitive(Class[]), ReflectionUtils.DataType.compare(Class[], Class[])

getAccessibleConstructor

public static Constructor<?> getAccessibleConstructor(String className,
                                                      ReflectionUtils.PackageType packageType,
                                                      Class<?>... parameterTypes)
                                               throws NoSuchMethodException,
                                                      ClassNotFoundException

Returns the accessible constructor of a desired class with the given parameter types

Parameters:

className - Name of the desired target class

packageType - Package where the desired target class is located

parameterTypes - Parameter types of the desired constructor

Returns:

The accessible constructor of the desired target class with the specified parameter types

Throws:

NoSuchMethodException - If the desired constructor with the specified parameter types cannot be found

ClassNotFoundException - If the desired target class with the specified name and package cannot be found

See Also:

getAccessibleConstructor(Class, Class...)

instantiateObject

public static Object instantiateObject(Class<?> clazz,
                                       Object... arguments)
                                throws InstantiationException,
                                       IllegalAccessException,
                                       IllegalArgumentException,
                                       InvocationTargetException,
                                       NoSuchMethodException

Returns an instance of a class with the given arguments

Parameters:

clazz - Target class

arguments - Arguments which are used to construct an object of the target class

Returns:

The instance of the target class with the specified arguments

Throws:

InstantiationException - If you cannot create an instance of the target class due to certain circumstances

IllegalAccessException - If the desired constructor cannot be accessed due to certain circumstances

IllegalArgumentException - If the types of the arguments do not match the parameter types of the constructor (this should not occur since it searches for a constructor with the types of the arguments)

InvocationTargetException - If the desired constructor cannot be invoked

NoSuchMethodException - If the desired constructor with the specified arguments cannot be found

instantiateObject

public static Object instantiateObject(String className,
                                       ReflectionUtils.PackageType packageType,
                                       Object... arguments)
                                throws InstantiationException,
                                       IllegalAccessException,
                                       IllegalArgumentException,
                                       InvocationTargetException,
                                       NoSuchMethodException,
                                       ClassNotFoundException

Returns an instance of a desired class with the given arguments

Parameters:

className - Name of the desired target class

packageType - Package where the desired target class is located

arguments - Arguments which are used to construct an object of the desired target class

Returns:

The instance of the desired target class with the specified arguments

Throws:

InstantiationException - If you cannot create an instance of the desired target class due to certain circumstances

IllegalAccessException - If the desired constructor cannot be accessed due to certain circumstances

IllegalArgumentException - If the types of the arguments do not match the parameter types of the constructor (this should not occur since it searches for a constructor with the types of the arguments)

InvocationTargetException - If the desired constructor cannot be invoked

NoSuchMethodException - If the desired constructor with the specified arguments cannot be found

ClassNotFoundException - If the desired target class with the specified name and package cannot be found

See Also:

instantiateObject(Class, Object...)

getMethod

public static Method getMethod(Class<?> clazz,
                               String methodName,
                               Class<?>... parameterTypes)
                        throws NoSuchMethodException

Returns a method of a class with the given parameter types

Parameters:

clazz - Target class

methodName - Name of the desired method

parameterTypes - Parameter types of the desired method

Returns:

The method of the target class with the specified name and parameter types

Throws:

NoSuchMethodException - If the desired method of the target class with the specified name and parameter types cannot be found

See Also:

ReflectionUtils.DataType.getPrimitive(Class[]), ReflectionUtils.DataType.compare(Class[], Class[])

getMethod

public static Method getMethod(String className,
                               ReflectionUtils.PackageType packageType,
                               String methodName,
                               Class<?>... parameterTypes)
                        throws NoSuchMethodException,
                               ClassNotFoundException

Returns a method of a desired class with the given parameter types

Parameters:

className - Name of the desired target class

packageType - Package where the desired target class is located

methodName - Name of the desired method

parameterTypes - Parameter types of the desired method

Returns:

The method of the desired target class with the specified name and parameter types

Throws:

NoSuchMethodException - If the desired method of the desired target class with the specified name and parameter types cannot be found

ClassNotFoundException - If the desired target class with the specified name and package cannot be found

See Also:

getMethod(Class, String, Class...)

getAccessibleMethod

public static Method getAccessibleMethod(Class<?> clazz,
                                         String methodName,
                                         Class<?>... parameterTypes)
                                  throws NoSuchMethodException

Returns an accessible method of a class with the given parameter types

Parameters:

clazz - Target class

methodName - Name of the desired method

parameterTypes - Parameter types of the desired method

Returns:

The method of the target class with the specified name and parameter types

Throws:

NoSuchMethodException - If the desired method of the target class with the specified name and parameter types cannot be found

See Also:

ReflectionUtils.DataType.getPrimitive(Class[]), ReflectionUtils.DataType.compare(Class[], Class[])

getAccessibleMethod

public static Method getAccessibleMethod(String className,
                                         ReflectionUtils.PackageType packageType,
                                         String methodName,
                                         Class<?>... parameterTypes)
                                  throws NoSuchMethodException,
                                         ClassNotFoundException

Returns an accessible method of a desired class with the given parameter types

Parameters:

className - Name of the desired target class

packageType - Package where the desired target class is located

methodName - Name of the desired method

parameterTypes - Parameter types of the desired method

Returns:

The method of the desired target class with the specified name and parameter types

Throws:

NoSuchMethodException - If the desired method of the desired target class with the specified name and parameter types cannot be found

ClassNotFoundException - If the desired target class with the specified name and package cannot be found

See Also:

getAccessibleMethod(Class, String, Class...)

invokeMethod

public static Object invokeMethod(Object instance,
                                  String methodName,
                                  Object... arguments)
                           throws IllegalAccessException,
                                  IllegalArgumentException,
                                  InvocationTargetException,
                                  NoSuchMethodException

Invokes a method on an object with the given arguments

Parameters:

instance - Target object

methodName - Name of the desired method

arguments - Arguments which are used to invoke the desired method

Returns:

The result of invoking the desired method on the target object

Throws:

IllegalAccessException - If the desired method cannot be accessed due to certain circumstances

IllegalArgumentException - If the types of the arguments do not match the parameter types of the method (this should not occur since it searches for a method with the types of the arguments)

InvocationTargetException - If the desired method cannot be invoked on the target object

NoSuchMethodException - If the desired method of the class of the target object with the specified name and arguments cannot be found

See Also:

getMethod(Class, String, Class...), ReflectionUtils.DataType.getPrimitive(Object[])

invokeMethod

public static Object invokeMethod(Object instance,
                                  Class<?> clazz,
                                  String methodName,
                                  Object... arguments)
                           throws IllegalAccessException,
                                  IllegalArgumentException,
                                  InvocationTargetException,
                                  NoSuchMethodException

Invokes a method of the target class on an object with the given arguments

Parameters:

instance - Target object

clazz - Target class

methodName - Name of the desired method

arguments - Arguments which are used to invoke the desired method

Returns:

The result of invoking the desired method on the target object

Throws:

IllegalAccessException - If the desired method cannot be accessed due to certain circumstances

IllegalArgumentException - If the types of the arguments do not match the parameter types of the method (this should not occur since it searches for a method with the types of the arguments)

InvocationTargetException - If the desired method cannot be invoked on the target object

NoSuchMethodException - If the desired method of the target class with the specified name and arguments cannot be found

See Also:

getMethod(Class, String, Class...), ReflectionUtils.DataType.getPrimitive(Object[])

invokeMethod

public static Object invokeMethod(Object instance,
                                  String className,
                                  ReflectionUtils.PackageType packageType,
                                  String methodName,
                                  Object... arguments)
                           throws IllegalAccessException,
                                  IllegalArgumentException,
                                  InvocationTargetException,
                                  NoSuchMethodException,
                                  ClassNotFoundException

Invokes a method of a desired class on an object with the given arguments

Parameters:

instance - Target object

className - Name of the desired target class

packageType - Package where the desired target class is located

methodName - Name of the desired method

arguments - Arguments which are used to invoke the desired method

Returns:

The result of invoking the desired method on the target object

Throws:

IllegalAccessException - If the desired method cannot be accessed due to certain circumstances

IllegalArgumentException - If the types of the arguments do not match the parameter types of the method (this should not occur since it searches for a method with the types of the arguments)

InvocationTargetException - If the desired method cannot be invoked on the target object

NoSuchMethodException - If the desired method of the desired target class with the specified name and arguments cannot be found

ClassNotFoundException - If the desired target class with the specified name and package cannot be found

See Also:

invokeMethod(Object, Class, String, Object...)

getField

public static Field getField(Class<?> clazz,
                             boolean declared,
                             String fieldName)
                      throws NoSuchFieldException,
                             SecurityException

Returns a field of the target class with the given name

Parameters:

clazz - Target class

declared - Whether the desired field is declared or not

fieldName - Name of the desired field

Returns:

The field of the target class with the specified name

Throws:

NoSuchFieldException - If the desired field of the given class cannot be found

SecurityException - If the desired field cannot be made accessible

getField

public static Field getField(String className,
                             ReflectionUtils.PackageType packageType,
                             boolean declared,
                             String fieldName)
                      throws NoSuchFieldException,
                             SecurityException,
                             ClassNotFoundException

Returns a field of a desired class with the given name

Parameters:

className - Name of the desired target class

packageType - Package where the desired target class is located

declared - Whether the desired field is declared or not

fieldName - Name of the desired field

Returns:

The field of the desired target class with the specified name

Throws:

NoSuchFieldException - If the desired field of the desired class cannot be found

SecurityException - If the desired field cannot be made accessible

ClassNotFoundException - If the desired target class with the specified name and package cannot be found

See Also:

getField(Class, boolean, String)

getAccessibleField

public static Field getAccessibleField(Class<?> clazz,
                                       boolean declared,
                                       String fieldName)
                                throws NoSuchFieldException,
                                       SecurityException

Returns an accessible field of the target class with the given name

Parameters:

clazz - Target class

declared - Whether the desired field is declared or not

fieldName - Name of the desired field

Returns:

The field of the target class with the specified name

Throws:

NoSuchFieldException - If the desired field of the given class cannot be found

SecurityException - If the desired field cannot be made accessible

getAccessibleField

public static Field getAccessibleField(String className,
                                       ReflectionUtils.PackageType packageType,
                                       boolean declared,
                                       String fieldName)
                                throws NoSuchFieldException,
                                       SecurityException,
                                       ClassNotFoundException

Returns an accessible field of a desired class with the given name

Parameters:

className - Name of the desired target class

packageType - Package where the desired target class is located

declared - Whether the desired field is declared or not

fieldName - Name of the desired field

Returns:

The field of the desired target class with the specified name

Throws:

NoSuchFieldException - If the desired field of the desired class cannot be found

SecurityException - If the desired field cannot be made accessible

ClassNotFoundException - If the desired target class with the specified name and package cannot be found

See Also:

getAccessibleField(Class, boolean, String)

getValue

public static Object getValue(Object instance,
                              Class<?> clazz,
                              boolean declared,
                              String fieldName)
                       throws IllegalArgumentException,
                              IllegalAccessException,
                              NoSuchFieldException,
                              SecurityException

Returns the value of a field of the given class of an object

Parameters:

instance - Target object

clazz - Target class

declared - Whether the desired field is declared or not

fieldName - Name of the desired field

Returns:

The value of field of the target object

Throws:

IllegalArgumentException - If the target object does not feature the desired field

IllegalAccessException - If the desired field cannot be accessed

NoSuchFieldException - If the desired field of the target class cannot be found

SecurityException - If the desired field cannot be made accessible

See Also:

getField(Class, boolean, String)

getValue

public static Object getValue(Object instance,
                              String className,
                              ReflectionUtils.PackageType packageType,
                              boolean declared,
                              String fieldName)
                       throws IllegalArgumentException,
                              IllegalAccessException,
                              NoSuchFieldException,
                              SecurityException,
                              ClassNotFoundException

Returns the value of a field of a desired class of an object

Parameters:

instance - Target object

className - Name of the desired target class

packageType - Package where the desired target class is located

declared - Whether the desired field is declared or not

fieldName - Name of the desired field

Returns:

The value of field of the target object

Throws:

IllegalArgumentException - If the target object does not feature the desired field

IllegalAccessException - If the desired field cannot be accessed

NoSuchFieldException - If the desired field of the desired class cannot be found

SecurityException - If the desired field cannot be made accessible

ClassNotFoundException - If the desired target class with the specified name and package cannot be found

See Also:

getValue(Object, Class, boolean, String)

getValue

public static Object getValue(Object instance,
                              boolean declared,
                              String fieldName)
                       throws IllegalArgumentException,
                              IllegalAccessException,
                              NoSuchFieldException,
                              SecurityException

Returns the value of a field with the given name of an object

Parameters:

instance - Target object

declared - Whether the desired field is declared or not

fieldName - Name of the desired field

Returns:

The value of field of the target object

Throws:

IllegalArgumentException - If the target object does not feature the desired field (should not occur since it searches for a field with the given name in the class of the object)

IllegalAccessException - If the desired field cannot be accessed

NoSuchFieldException - If the desired field of the target object cannot be found

SecurityException - If the desired field cannot be made accessible

See Also:

getValue(Object, Class, boolean, String)

setValue

public static void setValue(Object instance,
                            Class<?> clazz,
                            boolean declared,
                            String fieldName,
                            Object value)
                     throws IllegalArgumentException,
                            IllegalAccessException,
                            NoSuchFieldException,
                            SecurityException

Sets the value of a field of the given class of an object

Parameters:

instance - Target object

clazz - Target class

declared - Whether the desired field is declared or not

fieldName - Name of the desired field

value - New value

Throws:

IllegalArgumentException - If the type of the value does not match the type of the desired field

IllegalAccessException - If the desired field cannot be accessed

NoSuchFieldException - If the desired field of the target class cannot be found

SecurityException - If the desired field cannot be made accessible

See Also:

getField(Class, boolean, String)

setValue

public static void setValue(Object instance,
                            String className,
                            ReflectionUtils.PackageType packageType,
                            boolean declared,
                            String fieldName,
                            Object value)
                     throws IllegalArgumentException,
                            IllegalAccessException,
                            NoSuchFieldException,
                            SecurityException,
                            ClassNotFoundException

Sets the value of a field of a desired class of an object

Parameters:

instance - Target object

className - Name of the desired target class

packageType - Package where the desired target class is located

declared - Whether the desired field is declared or not

fieldName - Name of the desired field

value - New value

Throws:

IllegalArgumentException - If the type of the value does not match the type of the desired field

IllegalAccessException - If the desired field cannot be accessed

NoSuchFieldException - If the desired field of the desired class cannot be found

SecurityException - If the desired field cannot be made accessible

ClassNotFoundException - If the desired target class with the specified name and package cannot be found

See Also:

setValue(Object, Class, boolean, String, Object)

setValue

public static void setValue(Object instance,
                            boolean declared,
                            String fieldName,
                            Object value)
                     throws IllegalArgumentException,
                            IllegalAccessException,
                            NoSuchFieldException,
                            SecurityException

Sets the value of a field with the given name of an object

Parameters:

instance - Target object

declared - Whether the desired field is declared or not

fieldName - Name of the desired field

value - New value

Throws:

IllegalArgumentException - If the type of the value does not match the type of the desired field

IllegalAccessException - If the desired field cannot be accessed

NoSuchFieldException - If the desired field of the target object cannot be found

SecurityException - If the desired field cannot be made accessible

See Also:

setValue(Object, Class, boolean, String, Object)