com.izforge.izpack.api.data

Interface Overrides

public interface Overrides

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(String name) Returns whether an override for a given variable name exists in this container.
String	fetch(String name) Get override value for variable name and resolve variable references.
String	fetch(String name, String defaultValue) Get override value for variable name and resolve variable references.
File	getFile() Returns a reference to the overrides file used to initialize this container.
void	load() Loads the overrides from the file system.
String	remove(String name) Removes the override for a given variable name from the container.
void	setInstallData(InstallData installData) Initialize the installer runtime data.
int	size() Returns the overall number of overrides for variable values in this container.

Method Detail

fetch

String fetch(String name)

Get override value for variable name and resolve variable references.

Parameters:

name - the Izpack variable name

Returns:

the override value for the variable, if it exists

fetch

String fetch(String name,
             String defaultValue)

Get override value for variable name and resolve variable references. This method accepts a fallback value in case the override hasn't been defined.

Parameters:

name - the Izpack variable name

defaultValue -

Returns:

the override value for the variable, if it exists, or the given default value

containsKey

boolean containsKey(String name)

Returns whether an override for a given variable name exists in this container.

Parameters:

name - the Izpack variable name

Returns:

true if an override exists for the given name

remove

String remove(String name)

Removes the override for a given variable name from the container.

Parameters:

name - the Izpack variable name

Returns:

the override value of the removed entry

size

int size()

Returns the overall number of overrides for variable values in this container.

Returns:

the number of overrides in the current container

setInstallData

void setInstallData(InstallData installData)

Initialize the installer runtime data.

Parameters:

installData - the installer runtime data

getFile

File getFile()

Returns a reference to the overrides file used to initialize this container.

Returns:

the overrides file

load

void load()
   throws IOException

Loads the overrides from the file system. When using unresolved variables in defaults file include definitions call setInstallData(InstallData) first.

Throws:

IOException - if an I/O error occurs during loading