com.xatkit.util

Class Loader

java.lang.Object

com.xatkit.util.Loader

public class Loader
extends Object

Provides a set of utility methods to dynamically load and construct classes.

The Loader wraps Java reflection API exceptions in XatkitExceptions, easing client code to handle loading and construction errors.

Constructor Summary

Constructors

Constructor and Description
Loader()

Method Summary

Modifier and Type	Method and Description
static <T> T	construct(Class<T> clazz) Constructs a new instance of the provided clazz using its default constructor.
static <T> T	construct(Class<T> clazz, Class<?> parameterType1, Class<?> parameterType2, Object parameter1, Object parameter2) Constructs a new instance of the provided clazz with the given parameter1 and parameter2.
static <T> T	construct(Class<T> clazz, Class<?> parameterType, Object parameter) Constructs a new instance of the provided clazz with the given parameter.
static <T> T	construct(Class<T> clazz, List<Class<?>> parameterTypes, List<Object> parameters) Constructs a new instance of the provided clazz with the given parameters.
static <T> T	construct(Class<T> clazz, Object[] parameters) Constructs a new instance of clazz with the given parameters.
static RuntimeEventProvider	constructRuntimeEventProvider(Class<? extends RuntimeEventProvider> eventProviderClass, RuntimePlatform runtimePlatform, Configuration configuration) Constructs a new instance of the provided eventProviderClass with the given xatkitCore and configuration.
static RuntimePlatform	constructRuntimePlatform(Class<? extends RuntimePlatform> runtimePlatformClass, XatkitCore xatkitCore, Configuration configuration) Constructs a new instance of the provided runtimePlatformClass with the given xatkitCore and configuration.
static <T> Class<? extends T>	loadClass(String qualifiedName, Class<T> superClass) Loads the Class with the provided qualifiedName, and casts it to the provided superClass.

Methods inherited from class java.lang.Object

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

Constructor Detail

Loader

public Loader()

Method Detail

loadClass

public static <T> Class<? extends T> loadClass(String qualifiedName,
                                               Class<T> superClass)
                                        throws XatkitException

Loads the Class with the provided qualifiedName, and casts it to the provided superClass.

Type Parameters:

T - the super type of the Class to load

Parameters:

qualifiedName - the name of the Class to load

superClass - the super-class of the Class to load

Returns:

the loaded Class casted to the provided superClass

Throws:

XatkitException - if the provided qualifiedName is not a valid Class name, or if the loaded Class is not a sub-class of the provided superClass

construct

public static <T> T construct(Class<T> clazz,
                              Object[] parameters)
                       throws NoSuchMethodException,
                              InvocationTargetException

Constructs a new instance of clazz with the given parameters.

This method iterates through the clazz Constructors and attempt to find one that accepts the provided parameters. Note that this method tries to call all the Constructors that define as many parameters as the ones provided. If the parameters types are known use construct(Class, List, List) that directly calls the appropriate Constructor.

Type Parameters:

T - the type of the Class to construct an instance of

Parameters:

clazz - the Class to construct a new instance of

parameters - the concrete parameters of the constructor to call

Returns:

the constructed instance

Throws:

NoSuchMethodException - if the provided clazz does not define a constructor matching the provided parameters

InvocationTargetException - if the called constructor throws an exception

See Also:

construct(Class, List, List)

construct

public static <T> T construct(Class<T> clazz)
                       throws XatkitException

Constructs a new instance of the provided clazz using its default constructor.

Use construct(Class, Class, Object), construct(Class, Class, Class, Object, Object), construct(Class, List, List), or construct(Class, Object[]) to construct an instance of clazz with parameters.

Type Parameters:

T - the type of the Class to construct an instance of

Parameters:

clazz - the Class to construct a new instance of

Returns:

the constructed instance

Throws:

XatkitException - if an error occurred when calling the clazz's constructor

See Also:

construct(Class, Class, Object), construct(Class, List, List), construct(Class, Object[])

construct

public static <T> T construct(Class<T> clazz,
                              Class<?> parameterType,
                              Object parameter)
                       throws NoSuchMethodException,
                              XatkitException

Constructs a new instance of the provided clazz with the given parameter.

This method is equivalent to construct(clazz, Arrays.asList(parameterType), Arrays.asList(parameters).

Type Parameters:

T - the type of the Class to construct an instance of

Parameters:

clazz - the Class to construct a new instance of

parameterType - the parameter type in the constructor signature

parameter - the concrete parameter of the constructor to call

Returns:

the constructed instance

Throws:

NoSuchMethodException - if the provided clazz does not define a constructor matching the provided parameterType

XatkitException - if an error occurred when calling the clazz's constructor

See Also:

construct(Class, List, List)

construct

public static <T> T construct(Class<T> clazz,
                              Class<?> parameterType1,
                              Class<?> parameterType2,
                              Object parameter1,
                              Object parameter2)
                       throws NoSuchMethodException,
                              XatkitException

Constructs a new instance of the provided clazz with the given parameter1 and parameter2.

This method is equivalent to construct(clazz, Arrays.asList(parameterType1, parameterType2), Arrays .asList(parameter1, parameter2).

Type Parameters:

T - the type of the Class to construct an instance of

Parameters:

clazz - the Class to construct a new instance of

parameterType1 - the first parameter type in the constructor signature

parameterType2 - the second parameter type in the constructor signature

parameter1 - the first concrete parameter of the constructor to call

parameter2 - the second concrete parameter of the constructor to call

Returns:

the constructed instance

Throws:

NoSuchMethodException - if the provided clazz does not define a constructor matching the provided parameterType1 and parameterType2

XatkitException - if an error occurred when calling the clazz's constructor

See Also:

construct(Class, List, List)

construct

public static <T> T construct(Class<T> clazz,
                              List<Class<?>> parameterTypes,
                              List<Object> parameters)
                       throws NoSuchMethodException,
                              XatkitException

Constructs a new instance of the provided clazz with the given parameters.

This method uses the Java reflection API to find the constructor accepting the provided parameterTypes, and attempts to instantiate the provided clazz using the given parameters.

Type Parameters:

T - the type of the Class to construct an instance of

Parameters:

clazz - the Class to construct a new instance of

parameterTypes - the List of parameter types in the constructor signature

parameters - the concrete parameters of the constructor to call

Returns:

the constructed instance

Throws:

NoSuchMethodException - if the provided clazz does not define a constructor matching the provided parameterTypes

XatkitException - if an error occurred when calling the clazz's constructor

constructRuntimePlatform

public static RuntimePlatform constructRuntimePlatform(Class<? extends RuntimePlatform> runtimePlatformClass,
                                                       XatkitCore xatkitCore,
                                                       Configuration configuration)

Constructs a new instance of the provided runtimePlatformClass with the given xatkitCore and configuration.

This method first tries to construct an instance of the provided runtimePlatformClass with the provided xatkitCore and configuration. If the RuntimePlatform does not define such constructor, the method logs a warning and tries to construct an instance with only the xatkitCore parameter.

The runtimePlatformClass parameter can be loaded by using this class' loadClass(String, Class) utility method.

Parameters:

runtimePlatformClass - the RuntimePlatform Class to construct a new instance of

xatkitCore - the XatkitCore instance used to construct the RuntimePlatform

configuration - the Configuration instance used to construct the RuntimePlatform

Returns:

the constructed RuntimePlatform

Throws:

XatkitException - if the RuntimePlatform does not define a constructor matching the provided parameters.

See Also:

construct(Class, Class, Class, Object, Object), loadClass(String, Class)

constructRuntimeEventProvider

public static RuntimeEventProvider constructRuntimeEventProvider(Class<? extends RuntimeEventProvider> eventProviderClass,
                                                                 RuntimePlatform runtimePlatform,
                                                                 Configuration configuration)

Constructs a new instance of the provided eventProviderClass with the given xatkitCore and configuration.

This method first tries to construct an instance of the provided eventProviderClass with the provided xatkitCore and configuration. If the RuntimeEventProvider does not define such constructor, the method logs a warning and tries to construct an instance with only the xatkitCore parameter.

The eventProviderClass parameter can be loaded by using this class" loadClass(String, Class) utility method.

Parameters:

eventProviderClass - the RuntimeEventProvider Class to construct a new instance of

runtimePlatform - the RuntimePlatform instance used to construct the RuntimeEventProvider

configuration - the Configuration instance used to construct the RuntimeEventProvider

Returns:

the constructed RuntimeEventProvider

Throws:

XatkitException - if the RuntimeEventProvider does not define a constructor matching the provided parameters.

See Also:

construct(Class, Class, Class, Object, Object), loadClass(String, Class)