|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.Expand
public class Expand
Unzip a file.
| Field Summary | |
|---|---|
static java.lang.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 |
| Constructor Summary | |
|---|---|
Expand()
|
|
| Method Summary | |
|---|---|
void |
add(FileNameMapper fileNameMapper)
A nested filenamemapper |
void |
add(ResourceCollection rc)
Add a resource collection. |
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,
java.io.File srcF,
java.io.File dir)
This method is to be overridden by extending unarchival tasks. |
protected void |
expandResource(Resource srcR,
java.io.File dir)
This method is to be overridden by extending unarchival tasks. |
protected void |
extractFile(FileUtils fileUtils,
java.io.File srcF,
java.io.File dir,
java.io.InputStream compressedInputStream,
java.lang.String entryName,
java.util.Date entryDate,
boolean isDirectory,
FileNameMapper mapper)
extract a file to a directory |
protected FileNameMapper |
getMapper()
get a mapper for a file |
void |
setDest(java.io.File d)
Set the destination directory. |
void |
setEncoding(java.lang.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(java.io.File s)
Set the path to zip-file. |
| Methods inherited from class org.apache.tools.ant.Task |
|---|
bindToOwner, 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, setDescription, setLocation, setProject |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String ERROR_MULTIPLE_MAPPERS
| Constructor Detail |
|---|
public Expand()
| Method Detail |
|---|
public void execute()
throws BuildException
execute in class TaskBuildException - Thrown in unrecoverable error.
protected void expandFile(FileUtils fileUtils,
java.io.File srcF,
java.io.File dir)
fileUtils - the fileUtilssrcF - the source filedir - the destination directory
protected void expandResource(Resource srcR,
java.io.File dir)
srcR - the source resourcedir - the destination directoryprotected FileNameMapper getMapper()
protected void extractFile(FileUtils fileUtils,
java.io.File srcF,
java.io.File dir,
java.io.InputStream compressedInputStream,
java.lang.String entryName,
java.util.Date entryDate,
boolean isDirectory,
FileNameMapper mapper)
throws java.io.IOException
fileUtils - a fileUtils objectsrcF - the source filedir - the destination directorycompressedInputStream - the input streamentryName - the name of the entryentryDate - the date of the entryisDirectory - if this is true the entry is a directorymapper - the filename mapper to use
java.io.IOException - on errorpublic void setDest(java.io.File d)
d - Path to the directory.public void setSrc(java.io.File s)
s - Path to zip-file.public void setOverwrite(boolean b)
b - a boolean valuepublic void addPatternset(PatternSet set)
set - a pattern setpublic void addFileset(FileSet set)
set - a file setpublic void add(ResourceCollection rc)
rc - a resource collection.
public Mapper createMapper()
throws BuildException
BuildException - if more than one mapper is definedpublic void add(FileNameMapper fileNameMapper)
fileNameMapper - the mapper to addpublic void setEncoding(java.lang.String encoding)
Set to native-encoding if you want your
platform's native encoding, defaults to UTF8.
encoding - the name of the character encoding
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||