org.openksavi.sponge.engine

Interface PluginManager

All Superinterfaces:

Configurable, Descriptive, EngineModule, HasEngine, Manageable

public interface PluginManager
extends Configurable, EngineModule

Plugin Manager.

Method Summary

Modifier and Type	Method and Description
void	addPlugin(Plugin plugin) Adds the specified plugin.
<T extends Plugin> T	getPlugin(Class<T> cls) Returns the plugin that has the specified type or null if there is no such plugin.
<T extends Plugin> T	getPlugin(Class<T> cls, String name) Returns the plugin that has the specified name and type or null if there is no such plugin.
Plugin	getPlugin(String name) Returns a plugin identified by the name.
List<Plugin>	getPlugins() Returns plugin list.
boolean	hasPlugin(String name) Checks whether a plugin with the specified name is registered.
void	onAfterReload() Calls onAfterReload on plugins.
void	onBeforeReload() Calls onBeforeReload on plugins.
void	removePlugin(Plugin plugin) Removes the specified plugin.

Methods inherited from interface org.openksavi.sponge.config.Configurable

configure

Methods inherited from interface org.openksavi.sponge.util.Manageable

isFailed, isNew, isRunning, isStarting, isStopping, isTerminated, shutdown, startup

Methods inherited from interface org.openksavi.sponge.util.Descriptive

getDescription, getLabel, getName, setDescription, setLabel, setName

Methods inherited from interface org.openksavi.sponge.util.HasEngine

getEngine, setEngine

Method Detail

hasPlugin

boolean hasPlugin(String name)

Checks whether a plugin with the specified name is registered.

Parameters:

name - plugin name.

Returns:

true if the plugin is registered.

addPlugin

void addPlugin(Plugin plugin)

Adds the specified plugin.

Parameters:

plugin - plugin.

removePlugin

void removePlugin(Plugin plugin)

Removes the specified plugin.

Parameters:

plugin - plugin.

getPlugins

List<Plugin> getPlugins()

Returns plugin list.

Returns:

plugin list.

getPlugin

Plugin getPlugin(String name)

Returns a plugin identified by the name.

Parameters:

name - plugin name.

Returns:

plugin or null if there is no such plugin.

getPlugin

<T extends Plugin> T getPlugin(Class<T> cls,
                               String name)

Returns the plugin that has the specified name and type or null if there is no such plugin.

Type Parameters:

T - Plugin type.

Parameters:

cls - plugin class.

name - plugin name.

Returns:

plugin.

getPlugin

<T extends Plugin> T getPlugin(Class<T> cls)

Returns the plugin that has the specified type or null if there is no such plugin.

Type Parameters:

T - Plugin type.

Parameters:

cls - plugin class.

Returns:

plugin.

onBeforeReload

void onBeforeReload()

Calls onBeforeReload on plugins.

onAfterReload

void onAfterReload()

Calls onAfterReload on plugins.