com.izforge.izpack.api.data

Interface Variables

public interface Variables

A collection of variables.

Author:

Tim Anderson

Method Summary

Modifier and Type	Method and Description
void	add(DynamicVariable variable) Adds a dynamic variable.
boolean	containsOverride(String name) Whether the override exists of the given name.
String	get(String name) Returns the value of the specified variable.
String	get(String name, String defaultValue) Returns the value of the specified variable.
Set<String>	getBlockedVariableNames(Object blocker) Get a set of variable names that are blocked by blocking object.
boolean	getBoolean(String name) Returns the boolean value of the specified variable.
boolean	getBoolean(String name, boolean defaultValue) Returns the boolean value of the specified variable.
int	getInt(String name) Returns the integer value of the specified variable.
int	getInt(String name, int defaultValue) Returns the integer value of the specified variable.
long	getLong(String name) Returns the long value of the specified variable.
long	getLong(String name, long defaultValue) Returns the long value of the specified variable.
Overrides	getOverrides() Return all variables overrides.
Properties	getProperties() Exposes the variables as properties.
boolean	isBlockedVariableName(String name) Whether a variable is currently blocked against being refreshed.
void	refresh() Refreshes dynamic variables.
void	registerBlockedVariableNames(Set<String> names, Object blocker) Register a set of variable names for blocking from further changes.
String	replace(String value) Replaces any variables in the supplied value.
void	set(String name, String value) Sets a variable.
void	setOverrides(Overrides overrides) Exposes the variables as properties.
void	unregisterBlockedVariableNames(Set<String> names, Object blocker) Unregister a set of variable names from blocking from further changes.

Method Detail

set

void set(String name,
         String value)

Sets a variable.

Parameters:

name - the variable name

value - the variable value. May be null

get

String get(String name)

Returns the value of the specified variable.

Parameters:

name - the variable name

Returns:

the value. May be null

get

String get(String name,
           String defaultValue)

Returns the value of the specified variable.

Parameters:

name - the variable name

defaultValue - the default value if the variable doesn't exist, or is null

Returns:

the value, or defaultValue if the variable doesn't exist or is null

getBoolean

boolean getBoolean(String name)

Returns the boolean value of the specified variable.

Parameters:

name - the variable name

Returns:

the boolean value, or false if the variable doesn't exist or is not a boolean

getBoolean

boolean getBoolean(String name,
                   boolean defaultValue)

Returns the boolean value of the specified variable.

Parameters:

name - the variable name

defaultValue - the default value if the variable doesn't exist, or is null

Returns:

the boolean value, or defaultValue if the variable doesn't exist or is not a boolean

getInt

int getInt(String name)

Returns the integer value of the specified variable.

Parameters:

name - the variable name

Returns:

the integer value, or -1 if the variable doesn't exist or is not an integer

getInt

int getInt(String name,
           int defaultValue)

Returns the integer value of the specified variable.

Parameters:

name - the variable name

Returns:

the integer value, or defaultValue if the variable doesn't exist or is not an integer

getLong

long getLong(String name)

Returns the long value of the specified variable.

Parameters:

name - the variable name

Returns:

the long value, or -1 if the variable doesn't exist or is not a long

getLong

long getLong(String name,
             long defaultValue)

Returns the long value of the specified variable.

Parameters:

name - the variable name

Returns:

the long value, or defaultValue if the variable doesn't exist or is not a long

replace

String replace(String value)

Replaces any variables in the supplied value.

Parameters:

value - the value. May be null

Returns:

the value with variables replaced, or value if there were no variables to replace, or replacement failed

add

void add(DynamicVariable variable)

Adds a dynamic variable.

Parameters:

variable - the variable to add

refresh

void refresh()
      throws InstallerException

Refreshes dynamic variables.

Throws:

InstallerException - if variables cannot be refreshed

getProperties

Properties getProperties()

Exposes the variables as properties.

Returns:

the variables

registerBlockedVariableNames

void registerBlockedVariableNames(Set<String> names,
                                  Object blocker)

Register a set of variable names for blocking from further changes.

Parameters:

names - Variable names

blocker - Blocking object

getBlockedVariableNames

Set<String> getBlockedVariableNames(Object blocker)

Get a set of variable names that are blocked by blocking object.

Parameters:

blocker - Blocking object

Returns:

variables

unregisterBlockedVariableNames

void unregisterBlockedVariableNames(Set<String> names,
                                    Object blocker)

Unregister a set of variable names from blocking from further changes.

Parameters:

names - Variable names

blocker - Blocking object

isBlockedVariableName

boolean isBlockedVariableName(String name)

Whether a variable is currently blocked against being refreshed.

Parameters:

name - the variable name

containsOverride

boolean containsOverride(String name)

Whether the override exists of the given name.

Returns:

true if the override exists

setOverrides

void setOverrides(Overrides overrides)

Exposes the variables as properties.

getOverrides

Overrides getOverrides()

Return all variables overrides.

Returns:

the variables overrides