com.izforge.izpack.util.config

Class ConfigurableFileCopyTask

java.lang.Object

com.izforge.izpack.util.file.FileCopyTask

com.izforge.izpack.util.config.ConfigurableFileCopyTask

All Implemented Interfaces:

ConfigurableTask

Direct Known Subclasses:

IniFileCopyTask, OptionFileCopyTask

public abstract class ConfigurableFileCopyTask
extends FileCopyTask
implements ConfigurableTask

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cleanup

Fields inherited from class com.izforge.izpack.util.file.FileCopyTask

completeDirMap, destDir, destFile, dirCopyMap, failonerror, file, fileCopyMap, filesets, flatten, forceOverwrite, includeEmpty, mapperElement, preserveLastModified

Constructor Summary

Constructors

Constructor and Description
ConfigurableFileCopyTask()

Method Summary

Modifier and Type	Method and Description
protected abstract void	doFileOperation(File oldFile, File newFile, File toFile, boolean patchPreserveEntries, boolean patchPreserveValues, boolean patchResolveVariables) Do a patch operation.
protected void	doFileOperations() Actually does the file (and possibly empty directory) copies.
void	setCleanup(boolean cleanup) Whether to delete the patchfiles after the operation
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	setPatchResolveExpressions(boolean resolve) Whether variables should be resolved during patching.

Methods inherited from class com.izforge.izpack.util.file.FileCopyTask

add, addFileSet, buildMap, createMapper, execute, getPreserveLastModified, isEnableMultipleMapping, scan, setEnableMultipleMappings, setFailOnError, setFile, setFlatten, setGranularity, setIncludeEmptyDirs, setOverwrite, setPreserveLastModified, setToDir, setToFile, validateAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.izforge.izpack.util.config.ConfigurableTask

execute

Field Detail

cleanup

protected boolean cleanup

Constructor Detail

ConfigurableFileCopyTask

public ConfigurableFileCopyTask()

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

setPatchResolveExpressions

public void setPatchResolveExpressions(boolean resolve)

Whether variables should be resolved during patching.

Parameters:

resolve - - true to resolve in-value variables

setCleanup

public void setCleanup(boolean cleanup)

Whether to delete the patchfiles after the operation

Parameters:

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

doFileOperation

protected abstract void doFileOperation(File oldFile,
                                        File newFile,
                                        File toFile,
                                        boolean patchPreserveEntries,
                                        boolean patchPreserveValues,
                                        boolean patchResolveVariables)
                                 throws Exception

Do a patch operation.

Parameters:

oldFile - original file to patch from

newFile - newer reference file to patch certain values or entries to

toFile - output file of the patched result

patchPreserveEntries - set true to reserve old entries

patchPreserveValues - set true to reserver old values

patchResolveVariables - set true to resolve in-text variables during patching

Throws:

Exception

doFileOperations

protected void doFileOperations()
                         throws Exception

Description copied from class: FileCopyTask

Actually does the file (and possibly empty directory) copies. This is a good method for subclasses to override.

Overrides:

doFileOperations in class FileCopyTask

Throws:

Exception