com.electrotank.electroserver4.extensions.api.value
Class ExtensionComponentConfiguration

java.lang.Object
  com.electrotank.electroserver4.extensions.api.value.ExtensionComponentConfiguration

public class ExtensionComponentConfiguration
extends Object

Object class that holds the configuration of a single Plugin.

See Also:

RoomConfiguration, Plugin, ExtensionLifeCycle

Constructor Summary

ExtensionComponentConfiguration()
Constructs a new (empty) instance of ExtensionComponentConfiguration.

Method Summary

void	addVariables(EsObject object) Add variables to the plugin.
String	getExtensionName() Gets the name of the extension for the Plugin.
String	getHandle() Gets the handle for the plugin.
String	getName() Gets the name of the plugin.
EsObject	getVariables() Gets the variables for the plugin.
void	setExtensionName(String extensionName) Sets the name of the extension for the plugin.
void	setHandle(String pluginHandle) Sets the handle for the plugin.
void	setName(String pluginName) Sets the name of the plugin.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtensionComponentConfiguration

public ExtensionComponentConfiguration()

Constructs a new (empty) instance of ExtensionComponentConfiguration.

Method Detail

getExtensionName

public String getExtensionName()

Gets the name of the extension for the Plugin.

Returns:

name of extension

setExtensionName

public void setExtensionName(String extensionName)

Sets the name of the extension for the plugin.

Parameters:

extensionName - name of the extension

getHandle

public String getHandle()

Gets the handle for the plugin. The handle is the name by which the plugin can be addressed when instantiated in the room.

Returns:

handle

setHandle

public void setHandle(String pluginHandle)

Sets the handle for the plugin. The handle is the name by which the plugin can be addressed when instantiated in the room.

Parameters:

pluginHandle - handle

getName

public String getName()

Gets the name of the plugin. This is the name of the plugin in the Extension.xml file.

Returns:

name

setName

public void setName(String pluginName)

Sets the name of the plugin. This is the name of the plugin in the Extension.xml file.

Parameters:

pluginName - name

getVariables

public EsObject getVariables()

Gets the variables for the plugin.

Returns:

variables as an EsObject

addVariables

public void addVariables(EsObject object)

Add variables to the plugin.

Parameters:

object - EsObject containing variables to be added.