Package org.apache.tools.ant.taskdefs
Class Expand
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.Expand
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final StringError message when more that one mapper is definedstatic final StringFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidAdd a resource collection.voidadd(FileNameMapper fileNameMapper) A nested filenamemappervoidaddFileset(FileSet set) Add a filesetvoidaddPatternset(PatternSet set) Add a patternset.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 directoryWhether to allow the extracted file or directory to be outside of the dest directory.booleanWhether try ing to expand an empty archive would be an error.protected FileNameMapperget a mapper for a filebooleanprotected 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.voidsetAllowFilesToEscapeDest(boolean b) Whether to allow the extracted file or directory to be outside of the dest directory.voidSet 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.voidSet the path to zip-file.voidsetStripAbsolutePathSpec(boolean b) Whether leading path separators should be stripped.Methods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
- 
Field Details- 
NATIVE_ENCODING- See Also:
 
- 
ERROR_MULTIPLE_MAPPERSError message when more that one mapper is defined- See Also:
 
 
- 
- 
Constructor Details- 
Expandpublic Expand()Creates an Expand instance and sets encoding to UTF-8.
- 
ExpandCreates an Expand instance and sets the given encoding.- Parameters:
- encoding- String
- Since:
- Ant 1.9.5
 
 
- 
- 
Method Details- 
setFailOnEmptyArchivepublic void setFailOnEmptyArchive(boolean b) Whether try ing to expand an empty archive would be an error.- Parameters:
- b- boolean
- Since:
- Ant 1.8.0
 
- 
getFailOnEmptyArchivepublic boolean getFailOnEmptyArchive()Whether try ing to expand an empty archive would be an error.- Returns:
- boolean
- Since:
- Ant 1.8.0
 
- 
executeDo the work.- Overrides:
- executein class- Task
- Throws:
- BuildException- Thrown in unrecoverable error.
 
- 
expandFile
- 
expandResource
- 
getMapper
- 
extractFileprotected 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
- Throws:
- IOException- on error
 
- 
setDestSet the destination directory. File will be unzipped into the destination directory.- Parameters:
- d- Path to the directory.
 
- 
setSrc
- 
setOverwritepublic 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- booleanvalue
 
- 
addPatternset
- 
addFileset
- 
addAdd a resource collection.- Parameters:
- rc- a resource collection.
- Since:
- Ant 1.7
 
- 
createMapperDefines 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
 
- 
addA nested filenamemapper- Parameters:
- fileNameMapper- the mapper to add
- Since:
- Ant 1.6.3
 
- 
setEncodingSets the encoding to assume for file names and comments.Set to native-encodingif you want your platform's native encoding, defaults to UTF8.- Parameters:
- encoding- the name of the character encoding
- Since:
- Ant 1.6
 
- 
internalSetEncodingSupports grand-children that want to support the attribute where the child-class doesn't (i.e. Unzip in the compress Antlib).- Parameters:
- encoding- String
- Since:
- Ant 1.8.0
 
- 
getEncoding- Returns:
- String
- Since:
- Ant 1.8.0
 
- 
setStripAbsolutePathSpecpublic void setStripAbsolutePathSpec(boolean b) Whether leading path separators should be stripped.- Parameters:
- b- boolean
- Since:
- Ant 1.8.0
 
- 
setScanForUnicodeExtraFieldspublic void setScanForUnicodeExtraFields(boolean b) Whether unicode extra fields will be used if present.- Parameters:
- b- boolean
- Since:
- Ant 1.8.0
 
- 
internalSetScanForUnicodeExtraFieldsprotected 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).- Parameters:
- b- boolean
- Since:
- Ant 1.8.0
 
- 
getScanForUnicodeExtraFieldspublic boolean getScanForUnicodeExtraFields()- Returns:
- boolean
- Since:
- Ant 1.8.0
 
- 
setAllowFilesToEscapeDestpublic void setAllowFilesToEscapeDest(boolean b) Whether to allow the extracted file or directory to be outside of the dest directory.- Parameters:
- b- the flag
- Since:
- Ant 1.10.4
 
- 
getAllowFilesToEscapeDestWhether to allow the extracted file or directory to be outside of the dest directory.- Returns:
- nullif the flag hasn't been set explicitly, otherwise the value set by the user.
- Since:
- Ant 1.10.4
 
 
-