org.yawlfoundation.yawl.util

Class YPluginLoader

java.lang.Object

java.lang.ClassLoader

java.security.SecureClassLoader

java.net.URLClassLoader

org.yawlfoundation.yawl.util.YPluginLoader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class YPluginLoader
extends java.net.URLClassLoader

Loads classes from specified paths that implement or extend a particular class

Author:

Michael Adams

Created/Last Date:

16/04/14

Constructor Summary

Constructors

Constructor and Description
YPluginLoader(java.lang.String searchPath) Constructor

Method Summary

Modifier and Type	Method and Description
<T> T	getInstance(java.lang.Class<T> mask, java.lang.String instanceName) Loads a class that implements or subclasses a specified class and matches a specific name
<T> java.util.Set<java.lang.Class<T>>	load(java.lang.Class<T> mask) Loads the set of classes found in the search path that implement or subclass a specified class
<T> java.util.Map<java.lang.String,java.lang.Class<T>>	loadAsMap(java.lang.Class<T> mask)
<T> java.util.Set<java.lang.Class<T>>	loadInternal(java.lang.Class<T> mask) Loads the set of classes that implement or subclass a specified class that are members of the same package as that class

Methods inherited from class java.net.URLClassLoader

addURL, close, definePackage, findClass, findResource, findResources, getPermissions, getResourceAsStream, getURLs, newInstance, newInstance

Methods inherited from class java.security.SecureClassLoader

defineClass, defineClass

Methods inherited from class java.lang.ClassLoader

clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findLibrary, findLoadedClass, findSystemClass, getClassLoadingLock, getPackage, getPackages, getParent, getResource, getResources, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, loadClass, loadClass, registerAsParallelCapable, resolveClass, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners

Methods inherited from class java.lang.Object

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

Constructor Detail

YPluginLoader

public YPluginLoader(java.lang.String searchPath)

Constructor

Parameters:

searchPath - the path(s) to search for jar and class files. Multiple paths can be specified, separated by semi-colons (;). Any sub-directories are also searched

Method Detail

load

public <T> java.util.Set<java.lang.Class<T>> load(java.lang.Class<T> mask)

Loads the set of classes found in the search path that implement or subclass a specified class

Type Parameters:

T -

Parameters:

mask - the interface or super class to use as the basis of the search

Returns:

the set of matching classes

loadAsMap

public <T> java.util.Map<java.lang.String,java.lang.Class<T>> loadAsMap(java.lang.Class<T> mask)

loadInternal

public <T> java.util.Set<java.lang.Class<T>> loadInternal(java.lang.Class<T> mask)

Loads the set of classes that implement or subclass a specified class that are members of the same package as that class

Type Parameters:

T -

Parameters:

mask - the interface or super class to use as the basis of the load

Returns:

the set of matching classes

getInstance

public <T> T getInstance(java.lang.Class<T> mask,
                         java.lang.String instanceName)

Loads a class that implements or subclasses a specified class and matches a specific name

Type Parameters:

T -

Parameters:

mask - the interface or super class to use as the basis of the load

instanceName - the name of the class to load an instance of

Returns:

the loaded instance, or null if a matching class isn't found