org.apache.tools.ant.taskdefs

Class Expand

Implemented Interfaces:
Cloneable
Known Direct Subclasses:
Untar

public class Expand
extends Task

Unzip a file.
Since:
Ant 1.1

Field Summary

static String
ERROR_MULTIPLE_MAPPERS
Error message when more that one mapper is defined

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Method Summary

void
add(ResourceCollection rc)
Add a resource collection.
void
add(FileNameMapper fileNameMapper)
A nested filenamemapper
void
addFileset(FileSet set)
Add a fileset
void
addPatternset(PatternSet set)
Add a patternset.
Mapper
createMapper()
Defines the mapper to map source entries to destination files.
void
execute()
Do the work.
protected void
expandFile(FileUtils fileUtils, File srcF, File dir)
This method is to be overridden by extending unarchival tasks.
protected void
expandResource(Resource srcR, File dir)
This method is to be overridden by extending unarchival tasks.
protected void
extractFile(FileUtils fileUtils, File srcF, File dir, InputStream compressedInputStream, String entryName, Date entryDate, boolean isDirectory, FileNameMapper mapper)
extract a file to a directory
protected FileNameMapper
getMapper()
get a mapper for a file
void
setDest(File d)
Set the destination directory.
void
setEncoding(String encoding)
Sets the encoding to assume for file names and comments.
void
setOverwrite(boolean b)
Should we overwrite files in dest, even if they are newer than the corresponding entries in the archive?
void
setSrc(File s)
Set the path to zip-file.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Field Details

ERROR_MULTIPLE_MAPPERS

public static final String ERROR_MULTIPLE_MAPPERS
Error message when more that one mapper is defined

Method Details

add

public void add(ResourceCollection rc)
Add a resource collection.
Parameters:
rc - a resource collection.
Since:
Ant 1.7

add

public void add(FileNameMapper fileNameMapper)
A nested filenamemapper
Parameters:
fileNameMapper - the mapper to add
Since:
Ant 1.6.3

addFileset

public void addFileset(FileSet set)
Add a fileset
Parameters:
set - a file set

addPatternset

public void addPatternset(PatternSet set)
Add a patternset.
Parameters:
set - a pattern set

createMapper

public Mapper createMapper()
            throws BuildException
Defines the mapper to map source entries to destination files.
Returns:
a mapper to be configured
Throws:
BuildException - if more than one mapper is defined
Since:
Ant1.7

execute

public void execute()
            throws BuildException
Do the work.
Overrides:
execute in interface Task
Throws:
BuildException - Thrown in unrecoverable error.

expandFile

protected void expandFile(FileUtils fileUtils,
                          File srcF,
                          File dir)
This method is to be overridden by extending unarchival tasks.
Parameters:
fileUtils - the fileUtils
srcF - the source file
dir - the destination directory

expandResource

protected void expandResource(Resource srcR,
                              File dir)
This method is to be overridden by extending unarchival tasks.
Parameters:
srcR - the source resource
dir - the destination directory

extractFile

protected void extractFile(FileUtils fileUtils,
                           File srcF,
                           File dir,
                           InputStream compressedInputStream,
                           String entryName,
                           Date entryDate,
                           boolean isDirectory,
                           FileNameMapper mapper)
            throws IOException
extract a file to a directory
Parameters:
fileUtils - a fileUtils object
srcF - the source file
dir - the destination directory
compressedInputStream - the input stream
entryName - the name of the entry
entryDate - the date of the entry
isDirectory - if this is true the entry is a directory
mapper - the filename mapper to use

getMapper

protected FileNameMapper getMapper()
get a mapper for a file
Returns:
a filenamemapper for a file

setDest

public void setDest(File d)
Set the destination directory. File will be unzipped into the destination directory.
Parameters:
d - Path to the directory.

setEncoding

public void setEncoding(String encoding)
Sets the encoding to assume for file names and comments.

Set to native-encoding if you want your platform's native encoding, defaults to UTF8.

Parameters:
encoding - the name of the character encoding
Since:
Ant 1.6

setOverwrite

public void setOverwrite(boolean b)
Should we overwrite files in dest, even if they are newer than the corresponding entries in the archive?
Parameters:
b - a boolean value

setSrc

public void setSrc(File s)
Set the path to zip-file.
Parameters:
s - Path to zip-file.