org.apache.tools.ant.taskdefs
public class Expand extends Task
Since: Ant 1.1
UNKNOWN: category="packaging" name="unzip" name="unjar" name="unwar"
Field Summary | |
---|---|
static String | ERROR_MULTIPLE_MAPPERS Error message when more that one mapper is defined |
static String | NATIVE_ENCODING |
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 |
String | getEncoding() |
boolean | getFailOnEmptyArchive()
Whether try ing to expand an empty archive would be an error.
|
protected FileNameMapper | getMapper()
get a mapper for a file |
boolean | getScanForUnicodeExtraFields() |
protected void | internalSetEncoding(String encoding)
Supports grand-children that want to support the attribute
where the child-class doesn't (i.e. |
protected void | internalSetScanForUnicodeExtraFields(boolean b)
Supports grand-children that want to support the attribute
where the child-class doesn't (i.e. |
void | setDest(File d)
Set the destination directory. |
void | setEncoding(String encoding)
Sets the encoding to assume for file names and comments.
|
void | setFailOnEmptyArchive(boolean b)
Whether try ing to expand an empty archive would be an error.
|
void | setOverwrite(boolean b)
Should we overwrite files in dest, even if they are newer than
the corresponding entries in the archive? |
void | setScanForUnicodeExtraFields(boolean b)
Whether unicode extra fields will be used if present.
|
void | setSrc(File s)
Set the path to zip-file.
|
void | setStripAbsolutePathSpec(boolean b)
Whether leading path separators should be stripped.
|
Parameters: rc a resource collection.
Since: Ant 1.7
Parameters: fileNameMapper the mapper to add
Since: Ant 1.6.3
Parameters: set a file set
Parameters: set a pattern set
Returns: a mapper to be configured
Throws: BuildException if more than one mapper is defined
Since: Ant1.7
Throws: BuildException Thrown in unrecoverable error.
Parameters: fileUtils the fileUtils srcF the source file dir the destination directory
Parameters: srcR the source resource dir the destination 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
Since: Ant 1.8.0
Since: Ant 1.8.0
Returns: a filenamemapper for a file
Since: Ant 1.8.0
Since: Ant 1.8.0
Since: Ant 1.8.0
Parameters: d Path to the directory.
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
Since: Ant 1.8.0
Parameters: b a boolean
value
Since: Ant 1.8.0
Parameters: s Path to zip-file.
Since: Ant 1.8.0