nl.lockhead.lpf.plugins.plugin

Class PluginConfig

java.lang.Object

nl.lockhead.lpf.plugins.plugin.PluginConfig

public class PluginConfig
extends java.lang.Object

Contains the plugin's metadata, e.g. name, author, version

Method Summary

Modifier and Type	Method and Description
void	addMetadata(java.lang.String key, java.lang.Object value)
static PluginConfig	createConfig(java.lang.String pluginName, java.lang.String pluginAuthor, Version version) Generate a PluginConfig with the following values.
static PluginConfig	createConfig(java.lang.String pluginName, java.lang.String pluginAuthor, Version version, boolean registerEvents) Generate a PluginConfig with the following values.
java.lang.String	getAuthor()
java.util.Map<java.lang.String,java.lang.Object>	getMetadataMap()
java.lang.String	getName()
Version	getVersion()
void	removeMetadata(java.lang.String key)
void	setPluginAuthor(java.lang.String authorName)
void	setPluginName(java.lang.String pluginName)
void	setPluginVersion(Version pluginVersion)
boolean	shouldRegisterEvents()

Methods inherited from class java.lang.Object

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

Method Detail

createConfig

public static PluginConfig createConfig(java.lang.String pluginName,
                                        java.lang.String pluginAuthor,
                                        Version version)

Generate a PluginConfig with the following values. Assumes its events should be registered.

Parameters:

pluginName - the name of the plugin

pluginAuthor - the plugin's author

version - the version of the plugin

Returns:

the generated PluginConfig

createConfig

public static PluginConfig createConfig(java.lang.String pluginName,
                                        java.lang.String pluginAuthor,
                                        Version version,
                                        boolean registerEvents)

Generate a PluginConfig with the following values.

Parameters:

pluginName - the name of the plugin

pluginAuthor - the plugin's author

version - the version of the plugin

registerEvents - whether event listeners should be looked for, and registered

Returns:

the generated PluginConfig

setPluginName

public final void setPluginName(java.lang.String pluginName)
                         throws InvalidPluginException

Parameters:

pluginName - the name

Throws:

InvalidPluginException - if pluginName is null, or if it contains any non-alphanumeric characters, or if length < 3 || > 64

setPluginAuthor

public final void setPluginAuthor(java.lang.String authorName)
                           throws InvalidPluginException

Parameters:

authorName - the author name

Throws:

InvalidPluginException - if authorName is null, or if it contains any non-alphanumeric characters, or if length < 3 || > 64

setPluginVersion

public final void setPluginVersion(Version pluginVersion)
                            throws InvalidPluginException

Parameters:

pluginVersion - the Version

Throws:

InvalidPluginException - if the given Version is null

getName

public final java.lang.String getName()

getAuthor

public final java.lang.String getAuthor()

shouldRegisterEvents

public final boolean shouldRegisterEvents()

getVersion

public Version getVersion()

addMetadata

public void addMetadata(java.lang.String key,
                        java.lang.Object value)

removeMetadata

public void removeMetadata(java.lang.String key)

getMetadataMap

public java.util.Map<java.lang.String,java.lang.Object> getMetadataMap()