com.izforge.izpack.api.data

Interface Configurable

All Known Implementing Classes:

DefaultConfigurationHandler, Panel, PanelValidator

public interface Configurable

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

Method Detail

addConfigurationOption

void addConfigurationOption(String name,
                            ConfigurationOption option)

Add an optional configuration option to the implementing instance

Parameters:

name - Configuration option name

option - Configuration option

getConfigurationOptionValue

String getConfigurationOptionValue(String name)

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

Parameters:

name - Configuration option name

Returns:

the effective value or null

getConfigurationOptionValue

String getConfigurationOptionValue(String name,
                                   RulesEngine rules)

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

Parameters:

name - Configuration option name

rules - Current RulesEngine instance

Returns:

the effective value or null

getConfigurationOptionValue

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

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.

Parameters:

name - Configuration option name

rules - Current RulesEngine instance

defaultValue - default value if value is not configured.

Returns:

the effective value or null

getConfigurationOption

ConfigurationOption getConfigurationOption(String name)

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

Parameters:

name - Configuration option name

Returns:

the configuration option instance or null

getNames

Set<String> getNames()

Get all configuration option names

Returns:

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