Package dev.array21.bukkitreflectionlib

Class ReflectionUtil

java.lang.Object

dev.array21.bukkitreflectionlib.ReflectionUtil

public class ReflectionUtil
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVER_VERSION

Constructor Summary

Constructors

Constructor	Description
ReflectionUtil()

Method Summary

Modifier and Type	Method	Description
static Class<?>	getBukkitClass(String className)	Get a Class from the org.bukkit.craftbukkit.SERVER_VERSION.
static Constructor<?>	getConstructor(Class<?> clazz, Class<?>... args)	Get the Constructor of a Class
static Enum<?>	getEnum(Class<?> clazz, String constant)	Get an Enum from an Enum constant
static Enum<?>	getEnum(Class<?> clazz, String enumname, String constant)	Get an Enum constant by it's name and constant
static Field	getField(Class<?> clazz, String fieldName)	Get a Field
static int	getMajorVersion()	Get the current major Minecraft version.
static Method	getMethod(Class<?> clazz, String methodName, Class<?>... args)	Get a Method
static Class<?>	getMinecraftClass(String className)	1.17 and newer only Get a Class from the net.minecraft package
static Class<?>	getNmsClass(String className)	Deprecated.
static Object	getObject(Class<?> clazz, Object obj, String name)	Get the value of a Field, where the Class in which the Field is defined is explicitly given.
static Object	getObject(Object obj, Class<?> clazz, String name)	Deprecated. Use getObject(Class, Object, String) instead
static Object	getObject(Object obj, String name)	Get the value of a Field, where the Class in which the field is defined is derived from the provided Object
static Object	invokeConstructor(Class<?> clazz, Class<?>[] argTypes, Object[] args)	Invoke a Class' Constructor, where the argument types are explicitly given (Helpful when working with primitives)
static Object	invokeConstructor(Class<?> clazz, Object... args)	Invoke a Class' constructor.
static Object	invokeMethod(Class<?> clazz, Object obj, String methodName, Class<?>[] argTypes, Object[] args)	Invoke a Method where the Class where the Method is defined is explicitly given, and the argument types are explicitly given
static Object	invokeMethod(Class<?> clazz, Object obj, String methodName, Object... args)	Invoke a Method where the Class where to find the method is explicitly given (Helpful if the method is located in a superclass).
static Object	invokeMethod(Object obj, String methodName)	Invoke a Method which takes no arguments.
static Object	invokeMethod(Object obj, String methodName, Class<?>[] argTypes, Object[] args)	Invoke a Method where the argument types are explicitly given (Helpful when working with primitives).
static Object	invokeMethod(Object obj, String methodName, Object[] args)	Invoke a Method where the argument types are derived from the provided arguments.
static boolean	isUseNewSpigotPackaging()	Check if the new way of packaging Spigot is used For >=1.17 this will be true, for =<1.16 this will be false. This dictates if you should use getNmsClass(String) (<=1.16) or getMinecraftClass(String) (>=1.17).
static void	printFieldsInClass(Class<?> clazz)	Print all Fields in a Class.
static void	printMethodsInClass(Class<?> clazz)	Print all Methods in a Class with their parameters.

Methods inherited from class java.lang.Object

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

Field Details

SERVER_VERSION

public static String SERVER_VERSION

Constructor Details

ReflectionUtil

public ReflectionUtil()

Method Details

isUseNewSpigotPackaging

public static boolean isUseNewSpigotPackaging()

Check if the new way of packaging Spigot is used
For >=1.17 this will be true, for =<1.16 this will be false.
This dictates if you should use getNmsClass(String) (<=1.16) or getMinecraftClass(String) (>=1.17).

Returns:

Returns true if it is, false if it is now

getMajorVersion

public static int getMajorVersion()

Get the current major Minecraft version. E.g for Minecraft 1.18 this is 18.

Returns:

The current major Minecraft version

getBukkitClass

public static Class<?> getBukkitClass(String className)
                               throws ClassNotFoundException

Get a Class from the org.bukkit.craftbukkit.SERVER_VERSION. package

Parameters:

className - The name of the class

Returns:

Returns the Class

Throws:

ClassNotFoundException - Thrown when the Class was not found

getNmsClass

@Deprecated
public static Class<?> getNmsClass(String className)
                            throws ClassNotFoundException

Deprecated.

1.16 and older only Get a Class from the net.minecraft.server.SERVER_VERSION. package

Parameters:

className - The name of the class

Returns:

Returns the Class

Throws:

ClassNotFoundException - Thrown when the Class was not found

getMinecraftClass

public static Class<?> getMinecraftClass(String className)
                                  throws ClassNotFoundException

1.17 and newer only Get a Class from the net.minecraft package

Parameters:

className - The name of the class

Returns:

Returns the class

Throws:

ClassNotFoundException - Thrown when the Class was not found

getConstructor

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

Get the Constructor of a Class

Parameters:

clazz - The Class in which the Constructor is defined

args - Arguments taken by the Constructor

Returns:

Returns the Constructor

Throws:

NoSuchMethodException - Thrown when no Constructor in the Class was found with the provided combination of arguments

getEnum

public static Enum<?> getEnum(Class<?> clazz,
 String constant)

Get an Enum from an Enum constant

Parameters:

clazz - The Class in which the Enum is defined

constant - The name of the Enum Constant

Returns:

Returns the Enum or null if the Enum does not have a member called constant

getEnum

public static Enum<?> getEnum(Class<?> clazz,
 String enumname,
 String constant)
                       throws ClassNotFoundException

Get an Enum constant by it's name and constant

Parameters:

clazz - The Class in which the Enum is defined

enumname - The name of the Enum

constant - The name of the Constant

Returns:

Returns the Enum or null if the Enum does not have a member called constant

Throws:

ClassNotFoundException - If the Class does not have an Enum called enumname

getField

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

Get a Field

Parameters:

clazz - The Class in which the Field is defined

fieldName - The name of the Field

Returns:

Returns the Field

Throws:

NoSuchFieldException - Thrown when the Field was not present in the Class

getMethod

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

Get a Method

Parameters:

clazz - The Class in which the Method is defined

methodName - The name of the method

args - The argument types the method takes

Returns:

Returns the Method

Throws:

NoSuchMethodException

invokeMethod

public static Object invokeMethod(Object obj,
 String methodName)
                           throws NoSuchMethodException,
IllegalAccessException,
IllegalArgumentException,
InvocationTargetException

Invoke a Method which takes no arguments. The Class in which the Method is defined is derived from the provided Object

Parameters:

obj - The object to invoke the method on

methodName - The name of the Method

Returns:

Returns the result of the method, can be null if the method returns void

Throws:

NoSuchMethodException

IllegalAccessException

IllegalArgumentException

InvocationTargetException

invokeMethod

public static Object invokeMethod(Object obj,
 String methodName,
 Object[] args)
                           throws NoSuchMethodException,
IllegalAccessException,
IllegalArgumentException,
InvocationTargetException

Invoke a Method where the argument types are derived from the provided arguments. The Class in which the Method is defined is derived from the provided Object

Parameters:

obj - The object to invoke the method on

methodName - The name of the Method

args - The arguments to pass to the Method

Returns:

Returns the result of the method, can be null if the method returns void

Throws:

NoSuchMethodException

IllegalAccessException

IllegalArgumentException

InvocationTargetException

invokeMethod

public static Object invokeMethod(Object obj,
 String methodName,
 Class<?>[] argTypes,
 Object[] args)
                           throws NoSuchMethodException,
IllegalAccessException,
IllegalArgumentException,
InvocationTargetException

Invoke a Method where the argument types are explicitly given (Helpful when working with primitives). The Class in which the Method is defined is derived from the provided Object.

Parameters:

obj - The Object to invoke the method on

methodName - The name of the Method

argTypes - The types of arguments as a Class array

args - The arguments as an object array

Returns:

Returns the result of the method, can be null if the method returns void

Throws:

NoSuchMethodException

IllegalAccessException

IllegalArgumentException

InvocationTargetException

invokeMethod

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

Invoke a Method where the Class where to find the method is explicitly given (Helpful if the method is located in a superclass). The argument types are derived from the provided arguments

Parameters:

clazz - The Class where the method is located

obj - The Object to invoke the method on

methodName - The name of the method

args - The arguments to be passed to the method

Returns:

Returns the result of the method, can be null if the method returns void

Throws:

NoSuchMethodException

IllegalAccessException

IllegalArgumentException

InvocationTargetException

invokeMethod

public static Object invokeMethod(Class<?> clazz,
 Object obj,
 String methodName,
 Class<?>[] argTypes,
 Object[] args)
                           throws NoSuchMethodException,
IllegalAccessException,
IllegalArgumentException,
InvocationTargetException

Invoke a Method where the Class where the Method is defined is explicitly given, and the argument types are explicitly given

Parameters:

clazz - The Class in which the Method is located

obj - The Object on which to invoke the Method

methodName - The name of the Method

argTypes - Argument types

args - Arguments to pass to the method

Returns:

Returns the result of the method, can be null if the method returns void

Throws:

NoSuchMethodException

IllegalAccessException

IllegalArgumentException

InvocationTargetException

getObject

public static Object getObject(Object obj,
 String name)
                        throws NoSuchFieldException,
IllegalArgumentException,
IllegalAccessException

Get the value of a Field, where the Class in which the field is defined is derived from the provided Object

Parameters:

obj - The object in which the field is located, and from which to get the value

name - The name of the Field to get the value from

Returns:

Returns the value of the Field

Throws:

NoSuchFieldException

IllegalArgumentException

IllegalAccessException

getObject

@Deprecated
public static Object getObject(Object obj,
 Class<?> clazz,
 String name)
                        throws NoSuchFieldException,
IllegalArgumentException,
IllegalAccessException

Deprecated.

Use getObject(Class, Object, String) instead

Get the value of a Field, where the Class in which the Field is defined is explicitly given. (Helpful when the Field is in a superclass)

Parameters:

obj - The Object to get the value from

clazz - The Class in which the Field is defined

name - The name of the Field

Returns:

Returns the value of the Field

Throws:

NoSuchFieldException

IllegalArgumentException

IllegalAccessException

getObject

public static Object getObject(Class<?> clazz,
 Object obj,
 String name)
                        throws NoSuchFieldException,
IllegalArgumentException,
IllegalAccessException

Get the value of a Field, where the Class in which the Field is defined is explicitly given. (Helpful when the Field is in a superclass)

Parameters:

clazz - The Class in which the Field is defined

obj - The Object to get the value from

name - The name of the Field

Returns:

Returns the value of the Field

Throws:

NoSuchFieldException

IllegalArgumentException

IllegalAccessException

invokeConstructor

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

Invoke a Class' constructor. The argument types are derived from the provided arguments

Parameters:

clazz - The Class in which the Constructor is defined

args - The arguments to pass to the Constructor

Returns:

Returns an instance of the provided Class in which the Constructor is located

Throws:

NoSuchMethodException

InstantiationException

IllegalAccessException

IllegalArgumentException

InvocationTargetException

invokeConstructor

public static Object invokeConstructor(Class<?> clazz,
 Class<?>[] argTypes,
 Object[] args)
                                throws NoSuchMethodException,
InstantiationException,
IllegalAccessException,
IllegalArgumentException,
InvocationTargetException

Invoke a Class' Constructor, where the argument types are explicitly given (Helpful when working with primitives)

Parameters:

clazz - The Class in which the Constructor is defined

argTypes - The argument types

args - The arguments to pass to the constructor

Returns:

Returns an instance of the provided Class in which the Constructor is located

Throws:

NoSuchMethodException

InstantiationException

IllegalAccessException

IllegalArgumentException

InvocationTargetException

printMethodsInClass

public static void printMethodsInClass(Class<?> clazz)

Print all Methods in a Class with their parameters. Will print the Method's modifiers, return type, name and arguments and their types

Parameters:

clazz - The class to get methods from

printFieldsInClass

public static void printFieldsInClass(Class<?> clazz)

Print all Fields in a Class. Will print the Field's modifiers, type and name

Parameters:

clazz - The class to get fields from