com.izforge.izpack.util.config

Class ConfigFileTask

java.lang.Object

com.izforge.izpack.util.config.SingleConfigurableTask

com.izforge.izpack.util.config.ConfigFileTask

All Implemented Interfaces:

ConfigurableTask

Direct Known Subclasses:

SingleIniFileTask, SingleOptionFileTask

public abstract class ConfigFileTask
extends SingleConfigurableTask

Nested Class Summary

Nested classes/interfaces inherited from class com.izforge.izpack.util.config.SingleConfigurableTask

SingleConfigurableTask.Entry, SingleConfigurableTask.Unit

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cleanup
protected File	newFile
protected File	oldFile
protected File	toFile

Fields inherited from class com.izforge.izpack.util.config.SingleConfigurableTask

configurable, createConfigurable, fromConfigurable

Constructor Summary

Constructors

Constructor and Description
ConfigFileTask()

Method Summary

Modifier and Type	Method and Description
protected void	checkAttributes()
protected List<String>	getComment()
void	setCleanup(boolean cleanup) Whether to delete the patchfile after the operation
void	setComment(List<String> hdr) optional header comment for the file
void	setNewFile(File file) Location of the configuration file to be patched to; optional.
void	setOldFile(File file) Location of the configuration file to be patched from; optional.
void	setToFile(File file) Location of the resulting output file; required.

Methods inherited from class com.izforge.izpack.util.config.SingleConfigurableTask

addEntry, execute, readConfigurable, readSourceConfigurable, setAutoNumbering, setCreate, setEmptyLines, setEncoding, setEscape, setEscapeNewLine, setHeaderComment, setOperator, setPatchPreserveEntries, setPatchPreserveValues, setPatchResolveVariables, writeConfigurable

Methods inherited from class java.lang.Object

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

Field Detail

oldFile

protected File oldFile

newFile

protected File newFile

toFile

protected File toFile

cleanup

protected boolean cleanup

Constructor Detail

ConfigFileTask

public ConfigFileTask()

Method Detail

setNewFile

public void setNewFile(File file)

Location of the configuration file to be patched to; optional. If not set, any empty reference file is assumed, instead.

setOldFile

public void setOldFile(File file)

Location of the configuration file to be patched from; optional. If not set, attributes defining preservations of entries and values are ignored.

setToFile

public void setToFile(File file)

Location of the resulting output file; required.

setCleanup

public void setCleanup(boolean cleanup)

Whether to delete the patchfile after the operation

Parameters:

cleanup - True, if the patchfile should be deleted after the operation

setComment

public void setComment(List<String> hdr)

optional header comment for the file

getComment

protected List<String> getComment()

checkAttributes

protected void checkAttributes()
                        throws Exception

Specified by:

checkAttributes in class SingleConfigurableTask

Throws:

Exception