org.junit.gen5.commons.util

Class ReflectionUtils

java.lang.Object

org.junit.gen5.commons.util.ReflectionUtils

@API(value=Internal)
public final class ReflectionUtils
extends java.lang.Object

Collection of utilities for working with the Java reflection APIs.

DISCLAIMER

These utilities are intended solely for usage within the JUnit framework itself. Any usage by external parties is not supported. Use at your own risk!

Since:

5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReflectionUtils.MethodSortOrder

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.lang.Class<?>>	findAllClassesInClasspathRoot(java.io.File root, java.util.function.Predicate<java.lang.Class<?>> classTester)
static java.util.List<java.lang.Class<?>>	findAllClassesInPackage(java.lang.String basePackageName, java.util.function.Predicate<java.lang.Class<?>> classTester)
static java.util.List<java.lang.reflect.Method>	findAllMethodsInHierarchy(java.lang.Class<?> clazz, ReflectionUtils.MethodSortOrder sortOrder) Return all methods in superclass hierarchy except from Object.
static java.util.Optional<java.lang.reflect.Method>	findMethod(java.lang.Class<?> clazz, java.lang.String methodName, java.lang.Class<?>... parameterTypes)
static java.util.List<java.lang.reflect.Method>	findMethods(java.lang.Class<?> clazz, java.util.function.Predicate<java.lang.reflect.Method> predicate)
static java.util.List<java.lang.reflect.Method>	findMethods(java.lang.Class<?> clazz, java.util.function.Predicate<java.lang.reflect.Method> predicate, ReflectionUtils.MethodSortOrder sortOrder)
static java.util.List<java.lang.Class<?>>	findNestedClasses(java.lang.Class<?> clazz, java.util.function.Predicate<java.lang.Class<?>> predicate)
static java.util.Set<java.lang.Class<?>>	getAllAssignmentCompatibleClasses(java.lang.Class<?> clazz) Return all classes and interfaces that can be used as assignment types for instances of the specified Class, including itself.
static java.util.Set<java.io.File>	getAllClasspathRootDirectories()
static java.lang.ClassLoader	getDefaultClassLoader()
static java.util.Optional<java.lang.Object>	getOuterInstance(java.lang.Object inner)
static java.util.Optional<java.lang.Object>	getOuterInstance(java.lang.Object inner, java.lang.Class<?> targetType)
static java.lang.Object	invokeMethod(java.lang.reflect.Method method, java.lang.Object target, java.lang.Object... args) Invoke the supplied method, making it accessible if necessary and masking any checked exception as an unchecked exception.
static boolean	isAbstract(java.lang.Class<?> clazz)
static boolean	isAbstract(java.lang.reflect.Member member)
static boolean	isPackage(java.lang.String packageName)
static boolean	isPrivate(java.lang.Class<?> clazz)
static boolean	isPrivate(java.lang.reflect.Member member)
static boolean	isPublic(java.lang.Class<?> clazz)
static boolean	isPublic(java.lang.reflect.Member member)
static boolean	isStatic(java.lang.Class<?> clazz)
static boolean	isStatic(java.lang.reflect.Member member)
static java.util.Optional<java.lang.Class<?>>	loadClass(java.lang.String name)
static java.util.Optional<java.lang.Class<?>>	loadClass(java.lang.String name, java.lang.ClassLoader classLoader)
static java.util.Optional<java.lang.reflect.Method>	loadMethod(java.lang.String fullyQualifiedMethodName) Try to load a method by its fully qualified name (if such a thing exists for methods).
static <T> T	newInstance(java.lang.Class<T> clazz, java.lang.Object... args) Create a new instance of the specified Class by invoking the constructor whose argument list matches the types of the supplied arguments.
static <T> java.util.Optional<java.lang.Object>	readFieldValue(java.lang.Class<T> clazz, java.lang.String fieldName, T instance) Reads the value of a potentially inaccessible field.

Methods inherited from class java.lang.Object

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

Method Detail

getDefaultClassLoader

public static java.lang.ClassLoader getDefaultClassLoader()

isPublic

public static boolean isPublic(java.lang.Class<?> clazz)

isPublic

public static boolean isPublic(java.lang.reflect.Member member)

isPrivate

public static boolean isPrivate(java.lang.Class<?> clazz)

isPrivate

public static boolean isPrivate(java.lang.reflect.Member member)

isAbstract

public static boolean isAbstract(java.lang.Class<?> clazz)

isAbstract

public static boolean isAbstract(java.lang.reflect.Member member)

isStatic

public static boolean isStatic(java.lang.Class<?> clazz)

isStatic

public static boolean isStatic(java.lang.reflect.Member member)

newInstance

public static <T> T newInstance(java.lang.Class<T> clazz,
                                java.lang.Object... args)

Create a new instance of the specified Class by invoking the constructor whose argument list matches the types of the supplied arguments.

The constructor will be made accessible if necessary, and any checked exception will be masked as an unchecked exception.

Parameters:

clazz - the class to instantiate; never null

args - the arguments to pass to the constructor none of which may be null

Returns:

the new instance

See Also:

ExceptionUtils.throwAsUncheckedException(Throwable)

invokeMethod

public static java.lang.Object invokeMethod(java.lang.reflect.Method method,
                                            java.lang.Object target,
                                            java.lang.Object... args)

Invoke the supplied method, making it accessible if necessary and masking any checked exception as an unchecked exception.

Parameters:

method - the method to invoke; never null

target - the object on which to invoke the method; may be null if the method is static

args - the arguments to pass to the method

Returns:

the value returned by the method invocation or null if the return type is void

See Also:

ExceptionUtils.throwAsUncheckedException(Throwable)

loadClass

public static java.util.Optional<java.lang.Class<?>> loadClass(java.lang.String name)

loadClass

public static java.util.Optional<java.lang.Class<?>> loadClass(java.lang.String name,
                                                               java.lang.ClassLoader classLoader)

loadMethod

public static java.util.Optional<java.lang.reflect.Method> loadMethod(java.lang.String fullyQualifiedMethodName)

Try to load a method by its fully qualified name (if such a thing exists for methods).

Parameters:

fullyQualifiedMethodName - In the form 'package.subpackage.ClassName#methodName'

Returns:

Optional of Method

getOuterInstance

public static java.util.Optional<java.lang.Object> getOuterInstance(java.lang.Object inner)

getOuterInstance

public static java.util.Optional<java.lang.Object> getOuterInstance(java.lang.Object inner,
                                                                    java.lang.Class<?> targetType)

isPackage

public static boolean isPackage(java.lang.String packageName)

getAllClasspathRootDirectories

public static java.util.Set<java.io.File> getAllClasspathRootDirectories()

findAllClassesInClasspathRoot

public static java.util.List<java.lang.Class<?>> findAllClassesInClasspathRoot(java.io.File root,
                                                                               java.util.function.Predicate<java.lang.Class<?>> classTester)

findAllClassesInPackage

public static java.util.List<java.lang.Class<?>> findAllClassesInPackage(java.lang.String basePackageName,
                                                                         java.util.function.Predicate<java.lang.Class<?>> classTester)

findNestedClasses

public static java.util.List<java.lang.Class<?>> findNestedClasses(java.lang.Class<?> clazz,
                                                                   java.util.function.Predicate<java.lang.Class<?>> predicate)

findMethod

public static java.util.Optional<java.lang.reflect.Method> findMethod(java.lang.Class<?> clazz,
                                                                      java.lang.String methodName,
                                                                      java.lang.Class<?>... parameterTypes)

findMethods

public static java.util.List<java.lang.reflect.Method> findMethods(java.lang.Class<?> clazz,
                                                                   java.util.function.Predicate<java.lang.reflect.Method> predicate)

findMethods

public static java.util.List<java.lang.reflect.Method> findMethods(java.lang.Class<?> clazz,
                                                                   java.util.function.Predicate<java.lang.reflect.Method> predicate,
                                                                   ReflectionUtils.MethodSortOrder sortOrder)

findAllMethodsInHierarchy

public static java.util.List<java.lang.reflect.Method> findAllMethodsInHierarchy(java.lang.Class<?> clazz,
                                                                                 ReflectionUtils.MethodSortOrder sortOrder)

Return all methods in superclass hierarchy except from Object.

readFieldValue

public static <T> java.util.Optional<java.lang.Object> readFieldValue(java.lang.Class<T> clazz,
                                                                      java.lang.String fieldName,
                                                                      T instance)

Reads the value of a potentially inaccessible field.

If the field does not exist, an exception occurs while reading it, or the value of the field is null, an empty Optional is returned.

Parameters:

clazz - the class where the field is declared.

fieldName - the name of the field

instance - the instance from where the value is to be read

getAllAssignmentCompatibleClasses

public static java.util.Set<java.lang.Class<?>> getAllAssignmentCompatibleClasses(java.lang.Class<?> clazz)

Return all classes and interfaces that can be used as assignment types for instances of the specified Class, including itself.

Parameters:

clazz - the Class to lookup

See Also:

Class.isAssignableFrom(java.lang.Class<?>)