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 SummaryFields Modifier and Type Field Description static java.lang.StringERROR_MULTIPLE_MAPPERSError message when more that one mapper is definedstatic java.lang.StringNATIVE_ENCODING- 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Method SummaryModifier and Type Method Description voidadd(ResourceCollection rc)Add a resource collection.voidadd(FileNameMapper fileNameMapper)A nested filenamemappervoidaddFileset(FileSet set)Add a filesetvoidaddPatternset(PatternSet set)Add a patternset.MappercreateMapper()Defines the mapper to map source entries to destination files.voidexecute()Do the work.protected voidexpandFile(FileUtils fileUtils, java.io.File srcF, java.io.File dir)This method is to be overridden by extending unarchival tasks.protected voidexpandResource(Resource srcR, java.io.File dir)This method is to be overridden by extending unarchival tasks.protected voidextractFile(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 directoryjava.lang.BooleangetAllowFilesToEscapeDest()Whether to allow the extracted file or directory to be outside of the dest directory.java.lang.StringgetEncoding()booleangetFailOnEmptyArchive()Whether try ing to expand an empty archive would be an error.protected FileNameMappergetMapper()get a mapper for a filebooleangetScanForUnicodeExtraFields()protected voidinternalSetEncoding(java.lang.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.voidsetDest(java.io.File d)Set the destination directory.voidsetEncoding(java.lang.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(java.io.File s)Set 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, setTaskType
 - 
Methods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
- 
 
- 
- 
- 
Field Detail- 
NATIVE_ENCODINGpublic static final java.lang.String NATIVE_ENCODING - See Also:
- Constant Field Values
 
 - 
ERROR_MULTIPLE_MAPPERSpublic static final java.lang.String ERROR_MULTIPLE_MAPPERS Error message when more that one mapper is defined- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
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
 
 - 
executepublic void execute() throws BuildExceptionDo the work.- Overrides:
- executein class- Task
- Throws:
- BuildException- Thrown in unrecoverable error.
 
 - 
expandFileprotected void expandFile(FileUtils fileUtils, java.io.File srcF, java.io.File dir) This method is to be overridden by extending unarchival tasks.- Parameters:
- fileUtils- the fileUtils
- srcF- the source file
- dir- the destination directory
 
 - 
expandResourceprotected void expandResource(Resource srcR, java.io.File dir) This method is to be overridden by extending unarchival tasks.- Parameters:
- srcR- the source resource
- dir- the destination directory
 
 - 
getMapperprotected FileNameMapper getMapper() get a mapper for a file- Returns:
- a filenamemapper for a file
 
 - 
extractFileprotected 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 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:
- java.io.IOException- on error
 
 - 
setDestpublic void setDest(java.io.File d) Set the destination directory. File will be unzipped into the destination directory.- Parameters:
- d- Path to the directory.
 
 - 
setSrcpublic void setSrc(java.io.File s) Set the path to zip-file.- Parameters:
- s- Path to zip-file.
 
 - 
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
 
 - 
addPatternsetpublic void addPatternset(PatternSet set) Add a patternset.- Parameters:
- set- a pattern set
 
 - 
addFilesetpublic void addFileset(FileSet set) Add a fileset- Parameters:
- set- a file set
 
 - 
addpublic void add(ResourceCollection rc) Add a resource collection.- Parameters:
- rc- a resource collection.
- Since:
- Ant 1.7
 
 - 
createMapperpublic 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
 
 - 
addpublic void add(FileNameMapper fileNameMapper) A nested filenamemapper- Parameters:
- fileNameMapper- the mapper to add
- Since:
- Ant 1.6.3
 
 - 
setEncodingpublic void setEncoding(java.lang.String encoding) Sets 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
 
 - 
internalSetEncodingprotected void internalSetEncoding(java.lang.String encoding) Supports 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
 
 - 
getEncodingpublic java.lang.String 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
 
 - 
getAllowFilesToEscapeDestpublic java.lang.Boolean getAllowFilesToEscapeDest() Whether 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
 
 
- 
 
-