org.apache.tools.ant.taskdefs

Class Expand

public class Expand extends Task

Unzip a file.

Since: Ant 1.1

UNKNOWN: category="packaging" name="unzip" name="unjar" name="unwar"

Field Summary
static StringERROR_MULTIPLE_MAPPERS
Error message when more that one mapper is defined
static StringNATIVE_ENCODING
Method Summary
voidadd(ResourceCollection rc)
Add a resource collection.
voidadd(FileNameMapper fileNameMapper)
A nested filenamemapper
voidaddFileset(FileSet set)
Add a fileset
voidaddPatternset(PatternSet set)
Add a patternset.
MappercreateMapper()
Defines the mapper to map source entries to destination files.
voidexecute()
Do the work.
protected voidexpandFile(FileUtils fileUtils, File srcF, File dir)
This method is to be overridden by extending unarchival tasks.
protected voidexpandResource(Resource srcR, File dir)
This method is to be overridden by extending unarchival tasks.
protected voidextractFile(FileUtils fileUtils, File srcF, File dir, InputStream compressedInputStream, String entryName, Date entryDate, boolean isDirectory, FileNameMapper mapper)
extract a file to a directory
StringgetEncoding()
booleangetFailOnEmptyArchive()
Whether try ing to expand an empty archive would be an error.
protected FileNameMappergetMapper()
get a mapper for a file
booleangetScanForUnicodeExtraFields()
protected voidinternalSetEncoding(String encoding)
Supports grand-children that want to support the attribute where the child-class doesn't (i.e.
protected voidinternalSetScanForUnicodeExtraFields(boolean b)
Supports grand-children that want to support the attribute where the child-class doesn't (i.e.
voidsetDest(File d)
Set the destination directory.
voidsetEncoding(String encoding)
Sets the encoding to assume for file names and comments.
voidsetFailOnEmptyArchive(boolean b)
Whether try ing to expand an empty archive would be an error.
voidsetOverwrite(boolean b)
Should we overwrite files in dest, even if they are newer than the corresponding entries in the archive?
voidsetScanForUnicodeExtraFields(boolean b)
Whether unicode extra fields will be used if present.
voidsetSrc(File s)
Set the path to zip-file.
voidsetStripAbsolutePathSpec(boolean b)
Whether leading path separators should be stripped.

Field Detail

ERROR_MULTIPLE_MAPPERS

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

NATIVE_ENCODING

public static final String NATIVE_ENCODING

Method Detail

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()
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()
Do the work.

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)
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

Throws: IOException on error

getEncoding

public String getEncoding()

Since: Ant 1.8.0

getFailOnEmptyArchive

public boolean getFailOnEmptyArchive()
Whether try ing to expand an empty archive would be an error.

Since: Ant 1.8.0

getMapper

protected FileNameMapper getMapper()
get a mapper for a file

Returns: a filenamemapper for a file

getScanForUnicodeExtraFields

public boolean getScanForUnicodeExtraFields()

Since: Ant 1.8.0

internalSetEncoding

protected void internalSetEncoding(String encoding)
Supports grand-children that want to support the attribute where the child-class doesn't (i.e. Unzip in the compress Antlib).

Since: Ant 1.8.0

internalSetScanForUnicodeExtraFields

protected void internalSetScanForUnicodeExtraFields(boolean b)
Supports grand-children that want to support the attribute where the child-class doesn't (i.e. Unzip in the compress Antlib).

Since: Ant 1.8.0

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

setFailOnEmptyArchive

public void setFailOnEmptyArchive(boolean b)
Whether try ing to expand an empty archive would be an error.

Since: Ant 1.8.0

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

setScanForUnicodeExtraFields

public void setScanForUnicodeExtraFields(boolean b)
Whether unicode extra fields will be used if present.

Since: Ant 1.8.0

setSrc

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

Parameters: s Path to zip-file.

setStripAbsolutePathSpec

public void setStripAbsolutePathSpec(boolean b)
Whether leading path separators should be stripped.

Since: Ant 1.8.0