com.izforge.izpack.util.config

Class SingleConfigurableTask

java.lang.Object

com.izforge.izpack.util.config.SingleConfigurableTask

All Implemented Interfaces:

ConfigurableTask

Direct Known Subclasses:

ConfigFileTask, RegistryTask

public abstract class SingleConfigurableTask
extends Object
implements ConfigurableTask

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SingleConfigurableTask.Entry Instance of this class represents nested elements of a task configuration file.
static class	SingleConfigurableTask.Unit

Field Summary

Fields

Modifier and Type	Field and Description
protected Configurable	configurable
protected boolean	createConfigurable
protected Configurable	fromConfigurable

Constructor Summary

Constructors

Constructor and Description
SingleConfigurableTask()

Method Summary

Modifier and Type	Method and Description
void	addEntry(SingleConfigurableTask.Entry entry)
protected abstract void	checkAttributes()
void	execute()
protected abstract void	readConfigurable()
protected abstract void	readSourceConfigurable()
void	setAutoNumbering(boolean autoNumbering) Whether to use property auto numbering (for property names with a trailing '.')
void	setCreate(boolean create) Whether the configuration file or registry root entry should be created if it doesn't already exist (default: true).
void	setEmptyLines(boolean emptyLines) Whether to preserve empty lines
void	setEncoding(Charset encoding) The encoding to be used for loading and saving configuration files
void	setEscape(boolean escape) Whether to accept escape sequences
void	setEscapeNewLine(boolean escapeNewLine) Whether to interpret escape at the end of line for joining lines
void	setHeaderComment(boolean headerComment) Whether to use header comments
void	setOperator(String operator) The operator to use for separating name and value
void	setPatchPreserveEntries(boolean preserveEntries) Whether to preserve equal entries but not necessarily their values from an old configuration, if they can be found (default: true).
void	setPatchPreserveValues(boolean preserveValues) Whether to preserve the values of equal entries from an old configuration, if they can be found (default: true).
void	setPatchResolveVariables(boolean resolve) Whether variables should be resolved during patching.
protected abstract void	writeConfigurable()

Methods inherited from class java.lang.Object

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

Field Detail

createConfigurable

protected boolean createConfigurable

configurable

protected Configurable configurable

fromConfigurable

protected Configurable fromConfigurable

Constructor Detail

SingleConfigurableTask

public SingleConfigurableTask()

Method Detail

setPatchPreserveEntries

public void setPatchPreserveEntries(boolean preserveEntries)

Whether to preserve equal entries but not necessarily their values from an old configuration, if they can be found (default: true).

Parameters:

preserveEntries - - true to preserve equal entries from an old configuration

setPatchPreserveValues

public void setPatchPreserveValues(boolean preserveValues)

Whether to preserve the values of equal entries from an old configuration, if they can be found (default: true). Set false to overwrite old configuration values by default with the new ones, regardless whether they have been already set in an old configuration. Values from an old configuration can only be preserved, if the appropriate entries exist in an old configuration.

Parameters:

preserveValues - - true to preserve the values of equal entries from an old configuration

setPatchResolveVariables

public void setPatchResolveVariables(boolean resolve)

Whether variables should be resolved during patching.

Parameters:

resolve - - true to resolve in-value variables

setEscape

public void setEscape(boolean escape)

Whether to accept escape sequences

Parameters:

escape - - true to resolve escape sequences

setEscapeNewLine

public void setEscapeNewLine(boolean escapeNewLine)

Whether to interpret escape at the end of line for joining lines

Parameters:

escapeNewLine - - true to interpret escape at the end of line for joining lines

setHeaderComment

public void setHeaderComment(boolean headerComment)

Whether to use header comments

Parameters:

headerComment - - true to use header comments

setEmptyLines

public void setEmptyLines(boolean emptyLines)

Whether to preserve empty lines

Parameters:

emptyLines - - true to preserve empty lines

setAutoNumbering

public void setAutoNumbering(boolean autoNumbering)

Whether to use property auto numbering (for property names with a trailing '.')

Parameters:

autoNumbering - - true to use property auto numbering

setOperator

public void setOperator(String operator)

The operator to use for separating name and value

Parameters:

operator - - an operator string

setEncoding

public void setEncoding(Charset encoding)

The encoding to be used for loading and saving configuration files

Parameters:

encoding - - an encoding string

setCreate

public void setCreate(boolean create)

Whether the configuration file or registry root entry should be created if it doesn't already exist (default: true).

Parameters:

create - - whether to create a new configuration file or registry root entry

execute

public void execute()
             throws Exception

Specified by:

execute in interface ConfigurableTask

Throws:

Exception

checkAttributes

protected abstract void checkAttributes()
                                 throws Exception

Throws:

Exception

readSourceConfigurable

protected abstract void readSourceConfigurable()
                                        throws Exception

Throws:

Exception

readConfigurable

protected abstract void readConfigurable()
                                  throws Exception

Throws:

Exception

writeConfigurable

protected abstract void writeConfigurable()
                                   throws Exception

Throws:

Exception

addEntry

public void addEntry(SingleConfigurableTask.Entry entry)