Package com.fathzer.plugin.loader.classloader

Class ClassLoaderPluginLoader

java.lang.Object

com.fathzer.plugin.loader.PluginLoader<ClassLoader>

com.fathzer.plugin.loader.classloader.ClassLoaderPluginLoader

public class ClassLoaderPluginLoader
extends PluginLoader<ClassLoader>

A class able to load plugins from jar files contained in a folder.

Constructor Summary

Constructors

Constructor	Description
ClassLoaderPluginLoader()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected ClassLoader	buildClassLoader(ClassLoader context)	Builds the classloader that will be used to load the plugin classes.
<V> List<V>	getPlugins(Class<V> aClass)	Loads plugins using the context ClassLoader of the calling thread.
<V> List<V>	getPlugins(ClassLoader source, Class<V> aClass)	Gets the plugins contained in a source.

Methods inherited from class com.fathzer.plugin.loader.PluginLoader

withClassNameBuilder, withExceptionConsumer, withInstanceBuilder

Methods inherited from class java.lang.Object

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

Constructor Details

ClassLoaderPluginLoader

public ClassLoaderPluginLoader()

Constructor.
By default, the class name of the plugins are searched with a ServiceClassNameBuilder.
The plugins are instantiated using their public no argument constructor.
This makes the default behaviour quite similar to ServiceLoader

See Also:

• PluginLoader.withClassNameBuilder(ClassNameBuilder)
• PluginLoader.withInstanceBuilder(InstanceBuilder)

Method Details

getPlugins

public <V> List<V> getPlugins(Class<V> aClass)
                       throws IOException

Loads plugins using the context ClassLoader of the calling thread.

Type Parameters:

V - The plugins type

Parameters:

aClass - The interface/class implemented/sub-classed by the plugins

Returns:

A List of instances whose class loader is the classLoader returned by PluginLoader.buildClassLoader(Object).

Throws:

IOException - if a problem occurs while reading the source.

PluginInstantiationException - if a problem occurs while creating the plugins.

See Also:

• getPlugins(ClassLoader, Class)

getPlugins

public <V> List<V> getPlugins(ClassLoader source,
 Class<V> aClass)
                       throws IOException

Gets the plugins contained in a source. If that source is null, then the context ClassLoader of the calling thread is used.

Overrides:

getPlugins in class PluginLoader<ClassLoader>

Type Parameters:

V - The interface/class of the plugins (all plugins should implement/extends this interface/class).

Parameters:

source - The source to scan.

aClass - The interface/class implemented/sub-classed by the plugins

Returns:

A list of instances whose class loader is the classLoader returned by PluginLoader.buildClassLoader(Object).

Throws:

IOException - if a problem occurs while reading the source.

buildClassLoader

protected ClassLoader buildClassLoader(ClassLoader context)

Description copied from class: PluginLoader

Builds the classloader that will be used to load the plugin classes.

Specified by:

buildClassLoader in class PluginLoader<ClassLoader>

Parameters:

context - The context, for example, the path of a jar file.

Returns:

A classLoader that can load classes from the context.