org.pepsoft.worldpainter.plugins

Interface Plugin

All Known Subinterfaces:

BlockBasedPlatformProvider, ContextProvider, CustomLayerProvider, CustomObjectProvider, LayerEditorProvider, LayerProvider, MapExplorerSupport, OperationProvider, PlatformProvider, Provider<K>

All Known Implementing Classes:

AbstractPlatformProvider, AbstractPlugin, DefaultCustomObjectProvider, DefaultPlugin, JavaPlatformProvider

public interface Plugin

A WorldPainter plugin.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_MINIMUM_WORLDPAINTER_VERSION Deprecated.
static java.lang.String	PROPERTY_NAME The name of the plugin.
static java.lang.String	PROPERTY_UUIDS A comma-separated list of uuids that this plugin is locked to.
static java.lang.String	PROPERTY_VERSION The version number of the plugin.

Method Summary

Modifier and Type	Method and Description
default java.lang.String	getMinimumWorldPainterVersion() Deprecated.
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.
default void	init(WPContext context) Initialise the plugin.

Field Detail

PROPERTY_NAME

static final java.lang.String PROPERTY_NAME

The name of the plugin.

See Also:

Constant Field Values

PROPERTY_VERSION

static final java.lang.String PROPERTY_VERSION

The version number of the plugin.

See Also:

Constant Field Values

PROPERTY_UUIDS

static final java.lang.String PROPERTY_UUIDS

A comma-separated list of uuids that this plugin is locked to. Optional, when not present the plugin can be used by anyone.

See Also:

Constant Field Values

PROPERTY_MINIMUM_WORLDPAINTER_VERSION

@Deprecated
static final java.lang.String PROPERTY_MINIMUM_WORLDPAINTER_VERSION

Deprecated.

Deprecated. Use the minimumHostVersion property in the JSON descriptor instead.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

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

getPoperties().getProperty(Plugin.PROPERTY_NAME)

Returns:

The name of the plugin.

getVersion

java.lang.String getVersion()

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

getPoperties().getProperty(Plugin.PROPERTY_VERSION)

Returns:

The name of the plugin.

getUUIDs

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. Convenience method for parsing the result of:

getPoperties().getProperty(Plugin.PROPERTY_UUIDS)

Returns:

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

init

default void init(WPContext context)

Initialise the plugin. This is invoked once, after the application is initialised and all context is available.

The default implementation does nothing.

Parameters:

context - The WorldPainter application context.

getMinimumWorldPainterVersion

@Deprecated
default java.lang.String getMinimumWorldPainterVersion()

Deprecated.

Deprecated. Use the minimumHostVersion property in the JSON descriptor instead. This will never be invoked.

getProperties

java.util.Properties getProperties()

Get the properties of the plugin.

Returns:

The properties of the plugin.