org.myire.quill.common

Class ExternalToolLoader<T>

java.lang.Object

org.myire.quill.common.ExternalToolLoader<T>

Type Parameters:

T - The type that the external tool is accessed through, will not reference the external tool classes.

public class ExternalToolLoader<T>
extends java.lang.Object

An external tool loader enables loading the classes of an external tool from a dynamically created class path. It also ensures that the classes referencing those external tool classes are loaded by the same class loader, and not by the class loader that knows about the referencing classes but not the external tool classes.

Constructor Summary

Constructors

Constructor and Description
ExternalToolLoader(java.lang.Class<T> pProxyClass, java.lang.String pProxyImplementationPackage, java.lang.String pProxyImplementationClass, java.util.function.Supplier<org.gradle.api.file.FileCollection> pToolClassPathSource) Create a new ExternalToolLoader.

Method Summary

Modifier and Type	Method and Description
T	createToolProxy() Create an instance of the proxy implementation class.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalToolLoader

public ExternalToolLoader(java.lang.Class<T> pProxyClass,
                          java.lang.String pProxyImplementationPackage,
                          java.lang.String pProxyImplementationClass,
                          java.util.function.Supplier<org.gradle.api.file.FileCollection> pToolClassPathSource)

Create a new ExternalToolLoader.

Parameters:

pProxyClass - The class (normally an interface) through which the external tool is accessed.

pProxyImplementationPackage - The name of the package in which the proxy implementation class and any helper classes reside. All classes in this package will be loaded by the class loader that also loads the external tool classes.

pProxyImplementationClass - The name of the class that extends/implements the proxy class/interface and is allowed to reference the external tool classes.

pToolClassPathSource - A file collection containing the external tool classes.

Throws:

java.lang.NullPointerException - if any of the parameters is null.

Method Detail

createToolProxy

public T createToolProxy()
                  throws java.lang.ClassNotFoundException,
                         java.lang.IllegalAccessException,
                         java.lang.InstantiationException

Create an instance of the proxy implementation class.

Returns:

A new T implementation, never null.

Throws:

java.lang.ClassNotFoundException - if the implementation class cannot be found.

java.lang.IllegalAccessException - if the implementation class' default constructor isn't accessible.

java.lang.InstantiationException - if the implementation class doesn't have a default constructor, of if it is abstract, or cannot be instantiated for some other reason.

java.lang.ClassCastException - if the proxy implementation class cannot be cast to the proxy interface/class.