org.mule.munit.common.util

Class ClassUtils

java.lang.Object

org.apache.commons.lang3.ClassUtils

org.mule.munit.common.util.ClassUtils

public class ClassUtils
extends org.apache.commons.lang3.ClassUtils

ClassUtils contains useful methods for loading resources and classes This is based on the mule core class so we can have control over it

Since:

2.0.0

Author:

Mulesoft Inc.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.lang3.ClassUtils

org.apache.commons.lang3.ClassUtils.Interfaces

Field Summary

Fields

Modifier and Type	Field and Description
static Object[]	NO_ARGS

Fields inherited from class org.apache.commons.lang3.ClassUtils

INNER_CLASS_SEPARATOR, INNER_CLASS_SEPARATOR_CHAR, PACKAGE_SEPARATOR, PACKAGE_SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
ClassUtils()

Method Summary

Modifier and Type	Method and Description
static URL	getResource(String resourceName, Class<?> callingClass) Load a given resource.
static Enumeration<URL>	getResources(String resourceName, ClassLoader fallbackClassLoader) Find resources with a given name.
static Object	instantiateClass(String name, Object[] constructorArgs, Class<?> callingClass) Instantiates a class with a given name and arguments
static boolean	isClassOnPath(String className, Class currentClass) Can be used by service endpoints to select which service to use based on what's loaded on the classpath
static Class	loadClass(String className, Class<?> callingClass) Load a class with a given name.
static <T extends Class> T	loadClass(String className, Class<?> callingClass, T type) Load a class with a given name.

Methods inherited from class org.apache.commons.lang3.ClassUtils

convertClassesToClassNames, convertClassNamesToClasses, getAbbreviatedName, getAbbreviatedName, getAllInterfaces, getAllSuperclasses, getClass, getClass, getClass, getClass, getPackageCanonicalName, getPackageCanonicalName, getPackageCanonicalName, getPackageName, getPackageName, getPackageName, getPublicMethod, getShortCanonicalName, getShortCanonicalName, getShortCanonicalName, getShortClassName, getShortClassName, getShortClassName, getSimpleName, getSimpleName, hierarchy, hierarchy, isAssignable, isAssignable, isAssignable, isAssignable, isInnerClass, isPrimitiveOrWrapper, isPrimitiveWrapper, primitivesToWrappers, primitiveToWrapper, toClass, wrappersToPrimitives, wrapperToPrimitive

Methods inherited from class java.lang.Object

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

Field Detail

NO_ARGS

public static final Object[] NO_ARGS

Constructor Detail

ClassUtils

public ClassUtils()

Method Detail

getResource

public static URL getResource(String resourceName,
                              Class<?> callingClass)

Load a given resource.

This method will try to load the resource using the following methods (in order):

• From Thread.currentThread().getContextClassLoader()
• From ClassUtils.class.getClassLoader()
• From the callingClass.getClassLoader()

Parameters:

resourceName - The name of the resource to load

callingClass - The Class object of the calling object

Returns:

A URL pointing to the resource to load or null if the resource is not found

getResources

public static Enumeration<URL> getResources(String resourceName,
                                            ClassLoader fallbackClassLoader)

Find resources with a given name.

Resources are searched in the following order:

• current thread's context classLoader
• ClassUtilss class classLoader
• fallbackClassLoader passed on the parameter

Search stops as soon as any of the mentioned classLoaders has found a matching resource.

Parameters:

resourceName - resource being searched. Non empty.

fallbackClassLoader - classloader used to fallback the search. Non null.

Returns:

a non null Enumeration containing the found resources. Can be empty.

isClassOnPath

public static boolean isClassOnPath(String className,
                                    Class currentClass)

Can be used by service endpoints to select which service to use based on what's loaded on the classpath

Parameters:

className - The class name to look for

currentClass - the calling class

Returns:

true if the class is on the path

loadClass

public static Class loadClass(String className,
                              Class<?> callingClass)
                       throws ClassNotFoundException

Load a class with a given name.

It will try to load the class in the following order:

• From Thread.currentThread().getContextClassLoader()
• Using the basic Class.forName(java.lang.String)
• From ClassLoaderUtil.class.getClassLoader()
• From the callingClass.getClassLoader()

Parameters:

className - The name of the class to load

callingClass - The Class object of the calling object

Returns:

The Class instance

Throws:

ClassNotFoundException - If the class cannot be found anywhere.

loadClass

public static <T extends Class> T loadClass(String className,
                                            Class<?> callingClass,
                                            T type)
                                     throws ClassNotFoundException

Load a class with a given name.

It will try to load the class in the following order:

• From Thread.currentThread().getContextClassLoader()
• Using the basic Class.forName(java.lang.String)
• From ClassLoaderUtil.class.getClassLoader()
• From the callingClass.getClassLoader()

Parameters:

className - The name of the class to load

callingClass - The Class object of the calling object

type - the class type to expect to load

Returns:

The Class instance

Throws:

ClassNotFoundException - If the class cannot be found anywhere.

instantiateClass

public static Object instantiateClass(String name,
                                      Object[] constructorArgs,
                                      Class<?> callingClass)
                               throws ClassNotFoundException,
                                      SecurityException,
                                      NoSuchMethodException,
                                      IllegalArgumentException,
                                      InstantiationException,
                                      IllegalAccessException,
                                      InvocationTargetException

Instantiates a class with a given name and arguments

Parameters:

name - The name of the class to load

callingClass - The Class object of the calling object

constructorArgs - The arguments for the class constructor

Returns:

The Class instance

Throws:

ClassNotFoundException - If the class cannot be found anywhere.

SecurityException

NoSuchMethodException

IllegalArgumentException

InstantiationException

IllegalAccessException

InvocationTargetException