Package io.github.bakedlibs.dough.reflection

Class ReflectionUtils

java.lang.Object

io.github.bakedlibs.dough.reflection.ReflectionUtils

public final class ReflectionUtils
extends Object

This class provides some useful static methods to perform reflection.

Author:

TheBusyBiscuit

Method Summary

Modifier and Type	Method	Description
static <T> Constructor<T>	getConstructor(Class<T> c, Class<?>... paramTypes)	Returns the Constructor of a Class with the specified Parameters
static <T extends Enum<T>> T	getEnumConstant(Class<T> c, String name)	Returns a specific Enum Constant in an Enum
static <T extends Enum<T>> List<T>	getEnumConstants(Class<T> c)	Returns all Enum Constants in an Enum
static Field	getField(Class<?> c, String field)	Returns the Field of a Class
static <T> T	getFieldValue(Object object, Class<T> fieldType, String field)	Returns the Value of a Field in an Object
static Class<?>	getInnerNMSClass(String name, String subname)	Returns an NMS Class inside a Class
static Class<?>	getInnerOBCClass(String name, String subname)	Returns an OBC Class inside a Class
static Method	getMethod(Class<?> c, String method)	Returns a certain Method in the specified Class
static Method	getMethod(Class<?> c, String method, Class<?>... paramTypes)	Returns the Method with certain Parameters
static Method	getMethodOrAlternative(Class<?> c, String method, String alternative)	Returns a certain Method in the specified Class
static Class<?>	getNetMinecraftClass(String name)	Returns a `net.minecraft` class via Reflection.
static Class<?>	getNMSClass(String name)	Returns an NMS Class via Reflection
static Class<?>	getOBCClass(String name)	Returns an OBC Class via Reflection
static <T> void	setFieldValue(T object, Class<?> c, String field, Object value)	Modifies a Field in an Object
static <T> void	setFieldValue(T object, String field, Object value)	Modifies a Field in an Object
static Class<?>[]	toPrimitiveTypeArray(Class<?>[] classes)	Converts the Classes to a Primitive Type Array in order to be used as paramaters

Methods inherited from class java.lang.Object

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

Method Details

getMethod

@Nullable
public static Method getMethod(@Nonnull
 Class<?> c,
 @Nonnull
 String method)

Returns a certain Method in the specified Class

Parameters:

c - The Class in which the Method is in

method - The Method you are looking for

Returns:

The found Method

getMethodOrAlternative

@Nullable
public static Method getMethodOrAlternative(@Nonnull
 Class<?> c,
 @Nonnull
 String method,
 @Nonnull
 String alternative)

Returns a certain Method in the specified Class

Parameters:

c - The Class in which the Method is in

method - The Method you are looking for

alternative - The alternative Method you are looking for

Returns:

The found Method

getMethod

@Nullable
public static Method getMethod(@Nonnull
 Class<?> c,
 @Nonnull
 String method,
 Class<?>... paramTypes)

Returns the Method with certain Parameters

Parameters:

c - The Class in which the Method is in

method - The Method you are looking for

paramTypes - The Types of the Parameters

Returns:

The found Method

getField

@Nonnull
public static Field getField(@Nonnull
 Class<?> c,
 @Nonnull
 String field)
                      throws NoSuchFieldException

Returns the Field of a Class

Parameters:

c - The Class conating this Field

field - The name of the Field you are looking for

Returns:

The found Field

Throws:

NoSuchFieldException - If the field could not be found.

setFieldValue

public static <T> void setFieldValue(@Nonnull
 T object,
 @Nonnull
 Class<?> c,
 @Nonnull
 String field,
 @Nullable
 Object value)
                              throws NoSuchFieldException,
IllegalAccessException

Modifies a Field in an Object

Type Parameters:

T - The type of the specified field

Parameters:

object - The Object containing the Field

c - The Class in which we are looking for this field

field - The Name of that Field

value - The Value for that Field

Throws:

NoSuchFieldException - If the field could not be found.

IllegalAccessException - If the field could not be modified.

setFieldValue

public static <T> void setFieldValue(@Nonnull
 T object,
 @Nonnull
 String field,
 @Nullable
 Object value)
                              throws NoSuchFieldException,
IllegalAccessException

Modifies a Field in an Object

Type Parameters:

T - The type of the specified field

Parameters:

object - The Object containing the Field

field - The Name of that Field

value - The Value for that Field

Throws:

NoSuchFieldException - If the field could not be found.

IllegalAccessException - If the field could not be modified.

getFieldValue

@ParametersAreNonnullByDefault
@Nullable
public static <T> T getFieldValue(Object object,
 Class<T> fieldType,
 String field)
                           throws NoSuchFieldException,
IllegalAccessException

Returns the Value of a Field in an Object

Parameters:

object - The Object containing the Field

field - The Name of that Field

Returns:

The Value of a Field

Throws:

NoSuchFieldException - If the field could not be found.

IllegalAccessException - If the field could not be queried.

toPrimitiveTypeArray

@Nonnull
public static Class<?>[] toPrimitiveTypeArray(@Nonnull
 Class<?>[] classes)

Converts the Classes to a Primitive Type Array in order to be used as paramaters

Parameters:

classes - The Types you want to convert

Returns:

An Array of primitive Types

getConstructor

@Nullable
public static <T> Constructor<T> getConstructor(@Nonnull
 Class<T> c,
 Class<?>... paramTypes)

Returns the Constructor of a Class with the specified Parameters

Type Parameters:

T - The Type argument for the class of this constructor

Parameters:

c - The Class containing the Constructor

paramTypes - The Parameters for that Constructor

Returns:

The Constructor for that Class

getInnerNMSClass

@Nonnull
public static Class<?> getInnerNMSClass(@Nonnull
 String name,
 @Nonnull
 String subname)
                                 throws ClassNotFoundException,
UnknownServerVersionException

Returns an NMS Class inside a Class

Parameters:

name - The Name of the Class your Inner class is located in

subname - The Name of the inner Class you are looking for

Returns:

The Class in your specified Class

Throws:

ClassNotFoundException - If the class could not be found.

UnknownServerVersionException - If the MinecraftVersion was unable to be determined

getNetMinecraftClass

@Nonnull
public static Class<?> getNetMinecraftClass(@Nonnull
 String name)
                                     throws ClassNotFoundException,
UnknownServerVersionException

Returns a `net.minecraft` class via Reflection.

Parameters:

name - The class name of which to fetch

Returns:

The `net.minecraft` class.

Throws:

ClassNotFoundException - If the class does not exist

UnknownServerVersionException - If the MinecraftVersion was unable to be determined

getNMSClass

@Nonnull
public static Class<?> getNMSClass(@Nonnull
 String name)
                            throws ClassNotFoundException,
UnknownServerVersionException

Returns an NMS Class via Reflection

Parameters:

name - The Name of the Class you are looking for

Returns:

The Class in that Package

Throws:

ClassNotFoundException - If the class could not be found.

UnknownServerVersionException - If the MinecraftVersion was not able to be determined.

getInnerOBCClass

@ParametersAreNonnullByDefault
@Nonnull
public static Class<?> getInnerOBCClass(String name,
 String subname)
                                 throws ClassNotFoundException

Returns an OBC Class inside a Class

Parameters:

name - The Name of the Class your Inner class is located in

subname - The Name of the inner Class you are looking for

Returns:

The Class in your specified Class

Throws:

ClassNotFoundException - If the class could not be found.

getOBCClass

@Nonnull
public static Class<?> getOBCClass(@Nonnull
 String name)
                            throws ClassNotFoundException

Returns an OBC Class via Reflection

Parameters:

name - The Name of the Class you are looking for

Returns:

The Class in that Package

Throws:

ClassNotFoundException - If the class could not be found.

getEnumConstants

@Nonnull
public static <T extends Enum<T>> List<T> getEnumConstants(@Nonnull
 Class<T> c)

Returns all Enum Constants in an Enum

Type Parameters:

T - The Type argument of the enum we are querying

Parameters:

c - The Enum you are targeting

Returns:

An ArrayList of all Enum Constants in that Enum

getEnumConstant

@ParametersAreNonnullByDefault
@Nullable
public static <T extends Enum<T>> T getEnumConstant(Class<T> c,
 String name)

Returns a specific Enum Constant in an Enum

Type Parameters:

T - The Type argument of the enum we are querying

Parameters:

c - The Enum you are targeting

name - The Name of the Constant you are targeting

Returns:

The found Enum Constant