org.plugface.core.impl

Class DefaultPluginManager

java.lang.Object

org.plugface.core.impl.DefaultPluginManager

All Implemented Interfaces:

PluginManager

public class DefaultPluginManager
extends Object
implements PluginManager

Field Summary

Fields

Modifier and Type	Field and Description
protected AnnotationProcessor	annotationProcessor
protected PluginContext	context
protected DependencyResolver	dependencyResolver

Constructor Summary

Constructors

Constructor and Description
DefaultPluginManager(PluginContext context, AnnotationProcessor annotationProcessor, DependencyResolver dependencyResolver) Ideally not for public usage.

Method Summary

Modifier and Type	Method and Description
protected Object	create(Class<?> refClass)
Collection<PluginRef>	getAllPlugins() Return the complete list of all the plugins currently registered
<T> T	getPlugin(Class<T> pluginClass) Return an instance of the plugin matching the given type given type
<T> T	getPlugin(String name) Return an instance of the plugin that is registered with the given name
Collection<Object>	loadPlugins(PluginSource source) Load a set of plugin retrieved from the give PluginSource, instantiating the objects, resolving any dependency and registering them in the context
<T> void	register(String name, T plugin) Register a plugin in the context with the given name
<T> void	register(T plugin) Register a plugin in the context
<T> T	removePlugin(String name) Remove a plugin with the given name from the context
<T> T	removePlugin(T plugin) Remove a plugin from the context

Methods inherited from class java.lang.Object

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

Field Detail

context

protected final PluginContext context

annotationProcessor

protected final AnnotationProcessor annotationProcessor

dependencyResolver

protected final DependencyResolver dependencyResolver

Constructor Detail

DefaultPluginManager

public DefaultPluginManager(PluginContext context,
                            AnnotationProcessor annotationProcessor,
                            DependencyResolver dependencyResolver)

Ideally not for public usage. Use PluginManagers.defaultPluginManager() instead for a fully configured DefaultPluginManager

Parameters:

context - the PluginContext to use

annotationProcessor - the AnnotationProcessor to use

dependencyResolver - the DependencyResolver to use

Method Detail

register

public <T> void register(T plugin)

Description copied from interface: PluginManager

Register a plugin in the context

Specified by:

register in interface PluginManager

Type Parameters:

T - the inferred type of the plugin

Parameters:

plugin - the plugin object to register

register

public <T> void register(String name,
                         T plugin)

Description copied from interface: PluginManager

Register a plugin in the context with the given name

Specified by:

register in interface PluginManager

Type Parameters:

T - the inferred type of the plugin

Parameters:

name - the name to associate with the plugin

plugin - the plugin object to register

getPlugin

public <T> T getPlugin(String name)

Description copied from interface: PluginManager

Return an instance of the plugin that is registered with the given name

Specified by:

getPlugin in interface PluginManager

Type Parameters:

T - the inferred type of the plugin

Parameters:

name - the name of the plugin

Returns:

the plugin object or null if none exists

getPlugin

public <T> T getPlugin(Class<T> pluginClass)

Description copied from interface: PluginManager

Return an instance of the plugin matching the given type given type

Specified by:

getPlugin in interface PluginManager

Type Parameters:

T - the inferred type of the plugin

Parameters:

pluginClass - type the plugin must match; can be an interface or superclass. Cannot be null

Returns:

the plugin object or null if none exists

getAllPlugins

public Collection<PluginRef> getAllPlugins()

Description copied from interface: PluginManager

Return the complete list of all the plugins currently registered

Specified by:

getAllPlugins in interface PluginManager

Returns:

a Collection of all the plugins

removePlugin

public <T> T removePlugin(String name)

Description copied from interface: PluginManager

Remove a plugin with the given name from the context

Specified by:

removePlugin in interface PluginManager

Type Parameters:

T - the inferred type of the plugin

Parameters:

name - the name associated with the plugin

Returns:

the removed plugin, or null if none is exists

removePlugin

public <T> T removePlugin(T plugin)

Description copied from interface: PluginManager

Remove a plugin from the context

Specified by:

removePlugin in interface PluginManager

Type Parameters:

T - the inferred type of the plugin

Parameters:

plugin - the plugin instance to remove

Returns:

the removed plugin, or null if none is exists

loadPlugins

public Collection<Object> loadPlugins(PluginSource source)
                               throws Exception

Description copied from interface: PluginManager

Load a set of plugin retrieved from the give PluginSource, instantiating the objects, resolving any dependency and registering them in the context

Specified by:

loadPlugins in interface PluginManager

Parameters:

source - the PluginSource to use for loading

Returns:

a list of loaded plugins, never null

Throws:

Exception - an exception that occurred during loading, see PluginSource.load()

create

protected Object create(Class<?> refClass)