org.pepsoft.worldpainter.plugins

Class AbstractPlugin

java.lang.Object

org.pepsoft.worldpainter.plugins.AbstractPlugin

All Implemented Interfaces:

Plugin

Direct Known Subclasses:

AbstractPlatformProvider, DefaultCustomObjectProvider, DefaultPlugin

public abstract class AbstractPlugin
extends java.lang.Object
implements Plugin

An abstract base class for WorldPainter plugins.

Field Summary

Fields inherited from interface org.pepsoft.worldpainter.plugins.Plugin

PROPERTY_MINIMUM_WORLDPAINTER_VERSION, PROPERTY_NAME, PROPERTY_UUIDS, PROPERTY_VERSION

Constructor Summary

Constructors

Constructor and Description
AbstractPlugin(java.lang.String name, java.lang.String version) Create a new instance of AbstractPlugin.
AbstractPlugin(java.lang.String name, java.lang.String version, java.util.UUID uuid) Create a new instance of AbstractPlugin that is tied to a particular WorldPainter installation.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Get the name of the plugin.
java.util.Properties	getProperties() Get the properties of the plugin.
java.util.Set<java.util.UUID>	getUUIDs() Get the set of UUIDs this plugin is locked to, or null if the plugin can be used by anyone.
java.lang.String	getVersion() Get the version number of the plugin.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepsoft.worldpainter.plugins.Plugin

getMinimumWorldPainterVersion, init

Constructor Detail

AbstractPlugin

public AbstractPlugin(java.lang.String name,
                      java.lang.String version)

Create a new instance of AbstractPlugin.

Parameters:

name - The name of this plugin class. May or may not be the same as the name of the plugin in the descriptor, since one plugin may specify multiple plugin classes.

version - The version of this plugin class. May or may not be the same as the name of the plugin in the descriptor, since one plugin may specify multiple plugin classes.

AbstractPlugin

public AbstractPlugin(java.lang.String name,
                      java.lang.String version,
                      java.util.UUID uuid)

Create a new instance of AbstractPlugin that is tied to a particular WorldPainter installation.

Parameters:

name - The name of this plugin class. May or may not be the same as the name of the plugin in the descriptor, since one plugin may specify multiple plugin classes.

version - The version of this plugin class. May or may not be the same as the name of the plugin in the descriptor, since one plugin may specify multiple plugin classes.

uuid - The uuid of the WorldPainter installation to which this instance of the plugin should be tied.

Method Detail

getName

public final java.lang.String getName()

Description copied from interface: Plugin

Get the name of the plugin. Convenience method for (and must return the same as):

getPoperties().getProperty(Plugin.PROPERTY_NAME)

Specified by:

getName in interface Plugin

Returns:

The name of the plugin.

getVersion

public final java.lang.String getVersion()

Description copied from interface: Plugin

Get the version number of the plugin. Convenience method for (and must return the same as):

getPoperties().getProperty(Plugin.PROPERTY_VERSION)

Specified by:

getVersion in interface Plugin

Returns:

The name of the plugin.

getUUIDs

public final java.util.Set<java.util.UUID> getUUIDs()

Description copied from interface: Plugin

Get the set of UUIDs this plugin is locked to, or null if the plugin can be used by anyone. Convenience method for parsing the result of:

getPoperties().getProperty(Plugin.PROPERTY_UUIDS)

Specified by:

getUUIDs in interface Plugin

Returns:

The set of UUIDs this plugin is locked to, or null if the plugin can be used by anyone.

getProperties

public final java.util.Properties getProperties()

Description copied from interface: Plugin

Get the properties of the plugin.

Specified by:

getProperties in interface Plugin

Returns:

The properties of the plugin.