com.anwrt.anycontent.extensions.deploy
Class DeployParameter

java.lang.Object
  com.anwrt.anycontent.extensions.deploy.DeployParameter

public class DeployParameter

extends java.lang.Object

Handle a typed parameter for the deploy extension point.

Constructor Summary

DeployParameter(java.lang.String pluginName, Configuration configuration)
Create a deploy parameter

Method Summary

java.lang.String	getCategory() Get the category
java.lang.Object	getDefaultValue() Get the typed default value.
TypedParameterValuesEnumerator	getEnumerator() Get the enumerator.
java.lang.String	getGroup() Get the group
java.lang.String	getI18nKeyLabel() Get the label.
java.lang.String	getId() Get the id.
java.lang.String	getPluginName() Get the plugin name
int	getPriority() Get the parameter priority for display in īts group
int	getType() Get the type.
java.lang.String	getTypeAsString() Get a textual name for the parameter's type
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DeployParameter

public DeployParameter(java.lang.String pluginName,
                       Configuration configuration)
                throws ConfigurationException

Create a deploy parameter

Parameters:

pluginName - The name of the plugin owner of the parameter (name of its directory)

configuration - Configuration giving the parameter

Throws:

ConfigurationException - If mandatory parameters are missing, or default value are not matching type

Method Detail

getDefaultValue

public java.lang.Object getDefaultValue()

Get the typed default value.

Returns:

Returns the default value.

getI18nKeyLabel

public java.lang.String getI18nKeyLabel()

Get the label.

Returns:

Returns the i18n key of the label.

getId

public java.lang.String getId()

Get the id.

Returns:

Returns the id.

getType

public int getType()

Get the type.

Returns:

Returns the type.

getTypeAsString

public java.lang.String getTypeAsString()

Get a textual name for the parameter's type

Returns:

Returns the name of the type

getCategory

public java.lang.String getCategory()

Get the category

Returns:

Returns the category (several groups).

getGroup

public java.lang.String getGroup()

Get the group

Returns:

Returns the group (several parameters).

getPriority

public int getPriority()

Get the parameter priority for display in īts group

Returns:

Returns the priority (how to order parameter in the same group of the same category).

getEnumerator

public TypedParameterValuesEnumerator getEnumerator()

Get the enumerator.

Returns:

The enumerator of this parameter or null if this parameter is not enumerated

getPluginName

public java.lang.String getPluginName()

Get the plugin name

Returns:

Returns the plugin Name.

toString

public java.lang.String toString()