com.izforge.izpack.util.file

Class FileCopyTask

java.lang.Object

com.izforge.izpack.util.file.FileCopyTask

Direct Known Subclasses:

ConfigurableFileCopyTask

public class FileCopyTask
extends Object

Copies a file or directory to a new file or directory. Files are only copied if the source file is newer than the destination file, or when the destination file does not exist. It is possible to explicitly overwrite existing files.

This implementation is based on Arnout Kuiper's initial design document, the following mailing list discussions, and the copyfile/copydir tasks.

Field Summary

Fields

Modifier and Type	Field and Description
protected Hashtable<File,File>	completeDirMap
protected File	destDir
protected File	destFile
protected Hashtable<String,String[]>	dirCopyMap
protected boolean	failonerror
protected File	file
protected Hashtable<String,String[]>	fileCopyMap
protected Vector<FileSet>	filesets
protected boolean	flatten
protected boolean	forceOverwrite
protected boolean	includeEmpty
protected Mapper	mapperElement
protected boolean	preserveLastModified

Constructor Summary

Constructors

Constructor and Description
FileCopyTask() Copy task constructor.

Method Summary

Modifier and Type	Method and Description
void	add(FileNameMapper fileNameMapper) A nested filenamemapper
void	addFileSet(FileSet set) Adds a set of files to copy.
protected void	buildMap(File fromDir, File toDir, String[] names, FileNameMapper mapper, Hashtable<String,String[]> map) Add to a map of files/directories to copy
Mapper	createMapper() Defines the mapper to map source to destination files.
protected void	doFileOperations() Actually does the file (and possibly empty directory) copies.
void	execute() Performs the copy operation.
boolean	getPreserveLastModified() Whether to give the copied files the same last modified time as the original files.
boolean	isEnableMultipleMapping()
protected void	scan(File fromDir, File toDir, String[] files, String[] dirs) Compares source files to destination files to see if they should be copied.
void	setEnableMultipleMappings(boolean enableMultipleMappings) Attribute to handle mappers that return multiple mappings for a given source path.
void	setFailOnError(boolean failonerror) If false, note errors to the output but keep going.
void	setFile(File file) Sets a single source file to copy.
void	setFlatten(boolean flatten) When copying directory trees, the files can be "flattened" into a single directory.
void	setGranularity(long granularity) The number of milliseconds leeway to give before deciding a target is out of date.
void	setIncludeEmptyDirs(boolean includeEmpty) Used to copy empty directories.
void	setOverwrite(boolean overwrite) Overwrite any existing destination file(s).
void	setPreserveLastModified(boolean preserve) Give the copied files the same last modified time as the original files.
void	setToDir(File destDir) Sets the destination directory.
void	setToFile(File destFile) Sets the destination file.
protected void	validateAttributes() Ensure we have a consistent and legal set of attributes, and set any internal flags necessary based on different combinations of attributes.

Methods inherited from class java.lang.Object

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

Field Detail

file

protected File file

destFile

protected File destFile

destDir

protected File destDir

filesets

protected Vector<FileSet> filesets

preserveLastModified

protected boolean preserveLastModified

forceOverwrite

protected boolean forceOverwrite

flatten

protected boolean flatten

includeEmpty

protected boolean includeEmpty

failonerror

protected boolean failonerror

fileCopyMap

protected Hashtable<String,String[]> fileCopyMap

dirCopyMap

protected Hashtable<String,String[]> dirCopyMap

completeDirMap

protected Hashtable<File,File> completeDirMap

mapperElement

protected Mapper mapperElement

Constructor Detail

FileCopyTask

public FileCopyTask()

Copy task constructor.

Method Detail

setFile

public void setFile(File file)

Sets a single source file to copy.

Parameters:

file - the file to copy

setToFile

public void setToFile(File destFile)

Sets the destination file.

Parameters:

destFile - the file to copy to

setToDir

public void setToDir(File destDir)

Sets the destination directory.

Parameters:

destDir - the destination directory

setPreserveLastModified

public void setPreserveLastModified(boolean preserve)

Give the copied files the same last modified time as the original files.

Parameters:

preserve - if true perverse the modified time, default is false

getPreserveLastModified

public boolean getPreserveLastModified()

Whether to give the copied files the same last modified time as the original files.

Returns:

the preserveLastModified attribute

setOverwrite

public void setOverwrite(boolean overwrite)

Overwrite any existing destination file(s).

Parameters:

overwrite - if true force overwriting of destination file(s) even if the destination file(s) are younger than the corresponding source file. Default is false.

setFlatten

public void setFlatten(boolean flatten)

When copying directory trees, the files can be "flattened" into a single directory. If there are multiple files with the same name in the source directory tree, only the first file will be copied into the "flattened" directory, unless the forceoverwrite attribute is true.

Parameters:

flatten - if true flatten the destination directory. Default is false.

setIncludeEmptyDirs

public void setIncludeEmptyDirs(boolean includeEmpty)

Used to copy empty directories.

Parameters:

includeEmpty - if true copy empty directories. Default is true.

setEnableMultipleMappings

public void setEnableMultipleMappings(boolean enableMultipleMappings)

Attribute to handle mappers that return multiple mappings for a given source path.

Parameters:

enableMultipleMappings - If true the task will copy to all the mappings for a given source path, if false, only the first file or directory is processed. By default, this setting is false to provide backward compatibility with earlier releases.

isEnableMultipleMapping

public boolean isEnableMultipleMapping()

Returns:

the value of the enableMultipleMapping attribute

setFailOnError

public void setFailOnError(boolean failonerror)

If false, note errors to the output but keep going.

Parameters:

failonerror - true or false

addFileSet

public void addFileSet(FileSet set)

Adds a set of files to copy.

Parameters:

set - a set of files to copy

createMapper

public Mapper createMapper()
                    throws Exception

Defines the mapper to map source to destination files.

Returns:

a mapper to be configured

Throws:

Exception - if more than one mapper is defined

add

public void add(FileNameMapper fileNameMapper)
         throws Exception

A nested filenamemapper

Parameters:

fileNameMapper - the mapper to add

Throws:

Exception

setGranularity

public void setGranularity(long granularity)

The number of milliseconds leeway to give before deciding a target is out of date.

Default is 0 milliseconds, or 2 seconds on DOS systems.

execute

public void execute()
             throws Exception

Performs the copy operation.

Throws:

Exception - if an error occurs

validateAttributes

protected void validateAttributes()
                           throws Exception

Ensure we have a consistent and legal set of attributes, and set any internal flags necessary based on different combinations of attributes.

Throws:

Exception - if an error occurs

scan

protected void scan(File fromDir,
                    File toDir,
                    String[] files,
                    String[] dirs)
             throws Exception

Compares source files to destination files to see if they should be copied.

Parameters:

fromDir - The source directory

toDir - The destination directory

files - A list of files to copy

dirs - A list of directories to copy

Throws:

Exception

buildMap

protected void buildMap(File fromDir,
                        File toDir,
                        String[] names,
                        FileNameMapper mapper,
                        Hashtable<String,String[]> map)
                 throws Exception

Add to a map of files/directories to copy

Parameters:

fromDir - the source directory

toDir - the destination directory

names - a list of filenames

mapper - a FileNameMapper value

map - a map of source file to array of destination files

Throws:

Exception

doFileOperations

protected void doFileOperations()
                         throws Exception

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

Throws:

Exception