me.wavelength.betterreflection

Class BetterReflectionUtils

java.lang.Object

me.wavelength.betterreflection.BetterReflectionUtils

public class BetterReflectionUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static BetterReflectionClass	CLASS
static File	LAUNCH_JAR_FILE Caching the jar file on launch to make sure it's not null later.

Constructor Summary

Constructors

Constructor and Description
BetterReflectionUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	doParametersMatch(Class<?>[] parameters1, Class<?>[] parameters2)
static void	dumpMethodHeader(Method method, boolean includeModifiers, boolean includeReturnType, boolean includeParameterNames)
static String	generateMethodHeader(Method method, boolean includeModifiers, boolean includeReturnType, boolean includeParameterNames) * @param method the method to dump * @param includeModifiers whether the method's modifiers should be dumped * @param includeReturnType whether the method's return type should be dumped * @param includeParameterNames whether the method's parameter names should be dumped
static Class<?>[]	getClasses(Map<Integer,Class<?>> primitives, Object... parameterTypes) Deprecated. (renamed) use getTypes(Map, Object...)
static Class<?>[]	getClasses(Object... parameterTypes) Deprecated. (renamed) use getTypes(Object...)
static List<BetterReflectionClass>	getClassesFromNameBeginning(String packageName, String beginning) This method will use getClassesInPackage(String) to find all the classes in the specified package, it will then return a list of all the classes that start with beginning For example: getClassesFromNameBeginning("me.wavelength.betterreflection", "BetterReflection") Will return a list with the following classes: [ "BetterReflection", "BetterReflectionClass", "BetterReflectionUtils" ]
static List<BetterReflectionClass>	getClassesInPackage(String packageName)
static Constructor<?>	getConstructor(Class<?>[] parameterTypes, Constructor<?>[] constructors)
static JarFile	getCurrentJar()
static JarFile	getCurrentJar(BetterReflectionClass clasz)
static File	getCurrentJarFile()
static File	getCurrentJarFile(BetterReflectionClass clasz)
static List<File>	getDirectoriesFromPackageName(String packageName) This should only be invoked when launching on an IDE
static Field	getField(String name, Field[] fields)
static int	getJavaVersion() Gets the System property "java.version"
static Method	getMethod(String name, Class<?>[] parameterTypes, Method[] methods)
static Class<?>[]	getTypes(Map<Integer,Class<?>> primitives, Object... parameterTypes)
static Class<?>[]	getTypes(Object... parameterTypes)
static boolean	isRunningFromJar()
static boolean	isRunningFromJar(BetterReflectionClass clasz)
static boolean	isRunningOnAndroid()
static void	setFinal(Field field, boolean setFinal) Version is greater than or equal to 11 Provided by this StackOverflow post:

Methods inherited from class java.lang.Object

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

Field Detail

CLASS

public static final BetterReflectionClass CLASS

LAUNCH_JAR_FILE

public static final File LAUNCH_JAR_FILE

Caching the jar file on launch to make sure it's not null later.

Since:

0.4

Constructor Detail

BetterReflectionUtils

public BetterReflectionUtils()

Method Detail

getCurrentJarFile

public static File getCurrentJarFile(BetterReflectionClass clasz)

Parameters:

clasz - the class to get the jar for

Returns:

whether this program is running from a Jar file or not.

Since:

0.7

getCurrentJarFile

public static File getCurrentJarFile()

Returns:

whether this program is running from a Jar file or not.

Since:

0.4

getCurrentJar

public static JarFile getCurrentJar(BetterReflectionClass clasz)

Parameters:

clasz - the class to get the jar for

Returns:

an instance of JarFile from getCurrentJar()

Since:

0.7

getCurrentJar

public static JarFile getCurrentJar()

Returns:

an instance of JarFile from getCurrentJar()

Since:

0.4

isRunningFromJar

public static boolean isRunningFromJar(BetterReflectionClass clasz)

Parameters:

clasz - the class to check

Returns:

whether this program is running from a Jar file or not.

Since:

0.7

isRunningFromJar

public static boolean isRunningFromJar()

Returns:

whether this program is running from a Jar file or not.

Since:

0.4

isRunningOnAndroid

public static boolean isRunningOnAndroid()

Returns:

whether this program is running on Android environment.

This can easily be fooled and should not be trusted on its own.

Since:

0.5

getField

public static Field getField(String name,
                             Field[] fields)

getConstructor

public static Constructor<?> getConstructor(Class<?>[] parameterTypes,
                                            Constructor<?>[] constructors)

getMethod

public static Method getMethod(String name,
                               Class<?>[] parameterTypes,
                               Method[] methods)

doParametersMatch

public static boolean doParametersMatch(Class<?>[] parameters1,
                                        Class<?>[] parameters2)

getClasses

@Deprecated
public static Class<?>[] getClasses(Object... parameterTypes)

Deprecated. (renamed) use getTypes(Object...)

Parameters:

parameterTypes - the parameter types

Returns:

the parameter types' classes

getClasses

@Deprecated
public static Class<?>[] getClasses(Map<Integer,Class<?>> primitives,
                                                 Object... parameterTypes)

Deprecated. (renamed) use getTypes(Map, Object...)

Parameters:

primitives - a map of primitives to use for lookup

parameterTypes - the parameter types

Returns:

the parameter types' classes

getTypes

public static Class<?>[] getTypes(Object... parameterTypes)

Parameters:

parameterTypes - the parameter types

Returns:

the parameter types' classes

Since:

0.4 - preceded by getClasses(Object...)

getTypes

public static Class<?>[] getTypes(Map<Integer,Class<?>> primitives,
                                  Object... parameterTypes)

Parameters:

primitives - a map of primitives to use for lookup

parameterTypes - the parameter types

Returns:

the parameter types' classes

Since:

0.4 - preceded by getClasses(Map, Object...)

getDirectoriesFromPackageName

public static List<File> getDirectoriesFromPackageName(String packageName)
                                                throws IOException,
                                                       URISyntaxException

This should only be invoked when launching on an IDE

Parameters:

packageName - the package name

Returns:

a list of directories matching the package name.

Throws:

IOException - If I/O errors occur

URISyntaxException - If the resource's URL cannot be converted to URI

getClassesInPackage

public static List<BetterReflectionClass> getClassesInPackage(String packageName)
                                                       throws IOException,
                                                              URISyntaxException,
                                                              CannotReadJarException

Parameters:

packageName - the package name to scan

Returns:

a list of all the classes that reside in the specified package (this currently includes sub-packages but a boolean will be implemented for that)

Throws:

IOException - If I/O errors occur

URISyntaxException - If the resource's URL cannot be converted to URI

CannotReadJarException - If this method is invoked from a Jar and the Jar file cannot be found, or it cannot be read.

getClassesFromNameBeginning

public static List<BetterReflectionClass> getClassesFromNameBeginning(String packageName,
                                                                      String beginning)
                                                               throws IOException,
                                                                      URISyntaxException,
                                                                      CannotReadJarException

This method will use getClassesInPackage(String) to find all the classes in the specified package, it will then return a list of all the classes that start with beginning For example: getClassesFromNameBeginning("me.wavelength.betterreflection", "BetterReflection") Will return a list with the following classes: [ "BetterReflection", "BetterReflectionClass", "BetterReflectionUtils" ]

Parameters:

packageName - The package name to search inside of

beginning - the beginning of the class name

Returns:

The classes found that start with beginning

Throws:

IOException - If I/O errors occur

URISyntaxException - If the resource's URL cannot be converted to URI

CannotReadJarException - this is thrown if this method is run from a Jar and the Jar file cannot be found or it cannot be read.

getJavaVersion

public static int getJavaVersion()

Gets the System property "java.version"

Returns:

The current java version as integer (Java 8 (1.8) returns 8, Java 12 returns 12)

setFinal

public static void setFinal(Field field,
                            boolean setFinal)
                     throws Exception

Version is greater than or equal to 11 Provided by this StackOverflow post:

Parameters:

field - the field to change the modifier to

setFinal - whether the field should be set to final or not Java 16 or higher requires the following launch arguments to be added: --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/java.lang.reflect=ALL-UNNAMED

Removes (or adds) the final modifier to a field.

Throws:

Exception

generateMethodHeader

public static String generateMethodHeader(Method method,
                                          boolean includeModifiers,
                                          boolean includeReturnType,
                                          boolean includeParameterNames)

* @param method the method to dump * @param includeModifiers whether the method's modifiers should be dumped * @param includeReturnType whether the method's return type should be dumped * @param includeParameterNames whether the method's parameter names should be dumped

Returns:

the method's header (modifiers name(parameters), e.g. public String generateMethodHeader(Method method)

Since:

0.7

dumpMethodHeader

public static void dumpMethodHeader(Method method,
                                    boolean includeModifiers,
                                    boolean includeReturnType,
                                    boolean includeParameterNames)

Parameters:

method - the method to dump

includeModifiers - whether the method's modifiers should be dumped

includeReturnType - whether the method's return type should be dumped

includeParameterNames - whether the method's parameter names should be dumped

Since:

0.7 Writes generateMethodHeader(Method, boolean, boolean, boolean)} to stout