com.izforge.izpack.api.handler

Class DefaultConfigurationHandler

java.lang.Object

com.izforge.izpack.api.handler.DefaultConfigurationHandler

All Implemented Interfaces:

Configurable, Serializable

Direct Known Subclasses:

Panel, PanelValidator

public abstract class DefaultConfigurationHandler
extends Object
implements Configurable, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultConfigurationHandler()

Method Summary

Modifier and Type	Method and Description
void	addConfigurationOption(String name, ConfigurationOption option) Add an optional configuration option to the implementing instance
ConfigurationOption	getConfigurationOption(String name) Get an optional configuration value to the implementing instance from the implementing instance
String	getConfigurationOptionValue(String name) Get an optional configuration value to the implementing instance from the implementing instance
String	getConfigurationOptionValue(String name, RulesEngine rules) Get an optional configuration value to the implementing instance from the implementing instance
String	getConfigurationOptionValue(String name, RulesEngine rules, String defaultValue) Get an optional configuration value to the implementing instance from the implementing instance.
Set<String>	getNames() Get all configuration option names
void	readParameters(IXMLElement element) Returns the validation parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultConfigurationHandler

public DefaultConfigurationHandler()

Method Detail

addConfigurationOption

public void addConfigurationOption(String name,
                                   ConfigurationOption option)

Description copied from interface: Configurable

Add an optional configuration option to the implementing instance

Specified by:

addConfigurationOption in interface Configurable

Parameters:

name - Configuration option name

option - Configuration option

getConfigurationOption

public ConfigurationOption getConfigurationOption(String name)

Description copied from interface: Configurable

Get an optional configuration value to the implementing instance from the implementing instance

Specified by:

getConfigurationOption in interface Configurable

Parameters:

name - Configuration option name

Returns:

the configuration option instance or null

getConfigurationOptionValue

public String getConfigurationOptionValue(String name,
                                          RulesEngine rules,
                                          String defaultValue)

Description copied from interface: Configurable

Get an optional configuration value to the implementing instance from the implementing instance.
The defaultValue is not used if a configured option exists, but the option condition is not true.

Specified by:

getConfigurationOptionValue in interface Configurable

Parameters:

name - Configuration option name

rules - Current RulesEngine instance

defaultValue - default value if value is not configured.

Returns:

the effective value or null

getConfigurationOptionValue

public String getConfigurationOptionValue(String name)

Description copied from interface: Configurable

Get an optional configuration value to the implementing instance from the implementing instance

Specified by:

getConfigurationOptionValue in interface Configurable

Parameters:

name - Configuration option name

Returns:

the effective value or null

getConfigurationOptionValue

public String getConfigurationOptionValue(String name,
                                          RulesEngine rules)

Description copied from interface: Configurable

Get an optional configuration value to the implementing instance from the implementing instance

Specified by:

getConfigurationOptionValue in interface Configurable

Parameters:

name - Configuration option name

rules - Current RulesEngine instance

Returns:

the effective value or null

getNames

public Set<String> getNames()

Description copied from interface: Configurable

Get all configuration option names

Specified by:

getNames in interface Configurable

Returns:

a list of all configuration option names, or null if nothing has been configured

readParameters

public void readParameters(IXMLElement element)

Returns the validation parameters.