org.pepsoft.worldpainter.plugins

Class WPPluginManager

java.lang.Object

org.pepsoft.worldpainter.plugins.WPPluginManager

public class WPPluginManager
extends java.lang.Object

A manager of WorldPainter Plugins.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DESCRIPTOR_PATH The resource filename in which WorldPainter plugin descriptors are stored.

Method Summary

Modifier and Type	Method and Description
java.util.List<Plugin>	getAllPlugins() Get a list of all loaded WorldPainter plugins.
static WPPluginManager	getInstance() Obtain the single instance of the WorldPainter plugin manager.
<T extends Plugin> java.util.List<T>	getPlugins(java.lang.Class<T> type) Get a list of all loaded WorldPainter plugins which implement a particular type.
static void	initialise(java.util.UUID uuid) Initialise the WorldPainter plugin manager for a particular WorldPainter installation.
static void	initialise(java.util.UUID uuid, java.lang.ClassLoader classLoader) Initialise the WorldPainter plugin manager for a particular WorldPainter installation.

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTOR_PATH

public static final java.lang.String DESCRIPTOR_PATH

The resource filename in which WorldPainter plugin descriptors are stored. Pass this into the filename parameter of the PluginManager.loadPlugins(File, PublicKey, String, Version, boolean) method.

See Also:

Constant Field Values

Method Detail

getAllPlugins

public java.util.List<Plugin> getAllPlugins()

Get a list of all loaded WorldPainter plugins.

Returns:

A list of all loaded WorldPainter plugins.

getPlugins

public <T extends Plugin> java.util.List<T> getPlugins(java.lang.Class<T> type)

Get a list of all loaded WorldPainter plugins which implement a particular type.

Type Parameters:

T - The type of plugin to return.

Parameters:

type - The type of plugin to return.

Returns:

A list of all loaded WorldPainter plugins which implement the specified type

initialise

public static void initialise(java.util.UUID uuid)

Initialise the WorldPainter plugin manager for a particular WorldPainter installation. This method or initialise(UUID, ClassLoader) should be invoked only once, before getInstance() is invoked.

Please note! If plugins should be loaded from plugin jars, PluginManager.loadPlugins(File, PublicKey, String, Version, boolean) must be invoked before this method, to ensure the jars are discovered.

Parameters:

uuid - The unique identifier of the WorldPainter installation for which to initialise the WorldPainter plugin manager.

initialise

public static void initialise(java.util.UUID uuid,
                              java.lang.ClassLoader classLoader)

Initialise the WorldPainter plugin manager for a particular WorldPainter installation. This method or initialise(UUID) should be invoked only once, before getInstance() is invoked.

Please note! If plugins should be loaded from plugin jars, PluginManager.loadPlugins(File, PublicKey, String, Version, boolean) must be invoked before this method, to ensure the jars are discovered.

Parameters:

uuid - The unique identifier of the WorldPainter installation for which to initialise the WorldPainter plugin manager.

classLoader - The class loader from which to discover the default/system plugins (those not loaded from plugin jars).

getInstance

public static WPPluginManager getInstance()

Obtain the single instance of the WorldPainter plugin manager. Note that the plugin manager must be initialised first by invoking initialise(UUID) or initialise(UUID, ClassLoader).

Returns:

The single instance of the WorldPainter plugin manager.