org.apache.tools.ant.taskdefs
public class Zip extends MatchingTask
Since: Ant 1.1
UNKNOWN: category="packaging"
Nested Class Summary | |
---|---|
static class | Zip.ArchiveState
Holds the up-to-date status and the out-of-date resources of
the original archive.
|
static class | Zip.Duplicate
Possible behaviors when a duplicate file is added:
"add", "preserve" or "fail" |
static class | Zip.UnicodeExtraField
Policiy for creation of Unicode extra fields: never, always or
not-encodeable.
|
static class | Zip.WhenEmpty
Possible behaviors when there are no matching files for the task:
"fail", "skip", or "create". |
Field Summary | |
---|---|
protected Hashtable | addedDirs |
protected String | archiveType |
protected boolean | doubleFilePass
If this flag is true, execute() will run most operations twice,
the first time with skipWriting set to
true and the second time with setting it to false.
|
protected String | duplicate |
protected String | emptyBehavior |
protected Hashtable | entries |
protected boolean | skipWriting
whether the methods should just perform some sort of dry-run.
|
protected File | zipFile |
Method Summary | |
---|---|
void | add(ResourceCollection a)
Add a collection of resources to be archived. |
void | addFileset(FileSet set)
Adds a set of files. |
protected void | addParentDirs(File baseDir, String entry, ZipOutputStream zOut, String prefix, int dirMode)
Ensure all parent dirs of a given entry have been added. |
protected void | addResources(FileSet fileset, Resource[] resources, ZipOutputStream zOut)
Add the given resources.
|
protected void | addResources(ResourceCollection rc, Resource[] resources, ZipOutputStream zOut)
Add the given resources.
|
void | addZipfileset(ZipFileSet set)
Adds a set of files that can be
read from an archive and be given a prefix/fullpath. |
void | addZipGroupFileset(FileSet set)
Adds a group of zip files. |
protected void | cleanUp()
Do any clean up necessary to allow this instance to be used again.
|
protected boolean | createEmptyZip(File zipFile)
Create an empty zip file |
void | execute()
validate and build |
void | executeMain()
Build the zip file.
|
protected void | finalizeZipOutputStream(ZipOutputStream zOut)
method for subclasses to override |
String | getComment()
Comment of the archive
|
Zip.UnicodeExtraField | getCreateUnicodeExtraFields()
Whether Unicode extra fields will be created. |
protected ZipExtraField[] | getCurrentExtraFields()
Provides the extra fields for the zip entry currently being
added to the archive - if any. |
File | getDestFile()
The file to create. |
String | getEncoding()
Encoding to use for filenames. |
boolean | getFallBackToUTF8()
Whether to fall back to UTF-8 if a name cannot be enoded using
the specified encoding.
|
int | getLevel()
Get the compression level. |
protected Zip.ArchiveState | getNonFileSetResourcesToAdd(ResourceCollection[] rcs, File zipFile, boolean needsUpdate)
Collect the resources that are newer than the corresponding
entries (or missing) in the original archive.
|
boolean | getPreserve0Permissions()
Assume 0 Unix mode is intentional. |
protected Zip.ArchiveState | getResourcesToAdd(ResourceCollection[] rcs, File zipFile, boolean needsUpdate)
Collect the resources that are newer than the corresponding
entries (or missing) in the original archive.
|
protected Zip.ArchiveState | getResourcesToAdd(FileSet[] filesets, File zipFile, boolean needsUpdate)
Collect the resources that are newer than the corresponding
entries (or missing) in the original archive.
|
boolean | getUseLanguageEnodingFlag()
Whether the language encoding flag will be used. |
protected Resource[][] | grabNonFileSetResources(ResourceCollection[] rcs)
Fetch all included and not excluded resources from the collections.
|
protected Resource[][] | grabResources(FileSet[] filesets)
Fetch all included and not excluded resources from the sets.
|
protected boolean | hasUpdatedFile()
Get the value of the updatedFile attribute.
|
protected void | initZipOutputStream(ZipOutputStream zOut)
method for subclasses to override |
protected boolean | isAddingNewFiles()
Indicates if the task is adding new files into the archive as opposed to
copying back unchanged files from the backup copy |
boolean | isCompress()
Whether we want to compress the files or only store them; |
protected static boolean | isEmpty(Resource[][] r)
Check is the resource arrays are empty. |
protected boolean | isFirstPass()
Whether this is the first time the archive building methods are invoked.
|
boolean | isInUpdateMode()
Are we updating an existing archive? |
protected void | logWhenWriting(String msg, int level)
Logs a message at the given output level, but only if this is
the pass that will actually create the archive.
|
void | reset()
Makes this instance reset all attributes to their default
values and forget all children.
|
protected Resource[] | selectDirectoryResources(Resource[] orig)
Drops all non-directory resources from the given array. |
protected Resource[] | selectFileResources(Resource[] orig)
Drops all non-file resources from the given array. |
protected Resource[] | selectResources(Resource[] orig, ResourceSelector selector)
Drops all resources from the given array that are not selected |
void | setBasedir(File baseDir)
Directory from which to archive files; optional. |
void | setComment(String comment)
Comment to use for archive.
|
void | setCompress(boolean c)
Whether we want to compress the files or only store them;
optional, default=true; |
void | setCreateUnicodeExtraFields(Zip.UnicodeExtraField b)
Whether Unicode extra fields will be created. |
protected void | setCurrentExtraFields(ZipExtraField[] extra)
Sets the extra fields for the zip entry currently being
added to the archive - if any. |
void | setDestFile(File destFile)
The file to create; required. |
void | setDuplicate(Zip.Duplicate df)
Sets behavior for when a duplicate file is about to be added -
one of add , preserve or fail .
|
void | setEncoding(String encoding)
Encoding to use for filenames, defaults to the platform's
default encoding.
|
void | setFallBackToUTF8(boolean b)
Whether to fall back to UTF-8 if a name cannot be enoded using
the specified encoding.
|
void | setFile(File file)
This is the name/location of where to
create the file. |
void | setFilesonly(boolean f)
If true, emulate Sun's jar utility by not adding parent directories;
optional, defaults to false. |
void | setKeepCompression(boolean keep)
Whether the original compression of entries coming from a ZIP
archive should be kept (for example when updating an archive).
|
void | setLevel(int level)
Set the compression level to use. |
void | setPreserve0Permissions(boolean b)
Assume 0 Unix mode is intentional. |
void | setRoundUp(boolean r)
Whether the file modification times will be rounded up to the
next even number of seconds.
|
void | setUpdate(boolean c)
If true, updates an existing file, otherwise overwrite
any existing one; optional defaults to false. |
void | setUseLanguageEncodingFlag(boolean b)
Whether to set the language encoding flag. |
void | setWhenempty(Zip.WhenEmpty we)
Sets behavior of the task when no files match.
|
void | setZipfile(File zipFile)
This is the name/location of where to
create the .zip file. |
protected void | zipDir(File dir, ZipOutputStream zOut, String vPath, int mode)
Add a directory to the zip stream. |
protected void | zipDir(File dir, ZipOutputStream zOut, String vPath, int mode, ZipExtraField[] extra)
Add a directory to the zip stream. |
protected void | zipDir(Resource dir, ZipOutputStream zOut, String vPath, int mode, ZipExtraField[] extra)
Add a directory to the zip stream. |
protected void | zipFile(InputStream in, ZipOutputStream zOut, String vPath, long lastModified, File fromArchive, int mode)
Adds a new entry to the archive, takes care of duplicates as well.
|
protected void | zipFile(InputStream in, ZipOutputStream zOut, String vPath, long lastModified, File fromArchive, int mode, ZipExtraField[] extra)
Adds a new entry to the archive, takes care of duplicates as well.
|
protected void | zipFile(File file, ZipOutputStream zOut, String vPath, int mode)
Method that gets called when adding from java.io.File instances.
|
skipWriting
set to
true and the second time with setting it to false.
The only situation in Ant's current code base where this is ever going to be true is if the jar task has been configured with a filesetmanifest other than "skip".
Will only ever be true in the first pass if the task
performs two passes because doubleFilePass
is true.
Parameters: a the resources to archive
Since: Ant 1.7
Parameters: set the fileset to add
Parameters: baseDir the base directory to use (may be null) entry the entry name to create directories from zOut the stream to write to prefix a prefix to place on the created entries dirMode the directory mode
Throws: IOException on error
Since: Ant 1.5.2
Parameters: fileset may give additional information like fullpath or permissions. resources the resources to add zOut the stream to write to
Throws: IOException on error
Since: Ant 1.5.2
Parameters: rc may give additional information like fullpath or permissions. resources the resources to add zOut the stream to write to
Throws: IOException on error
Since: Ant 1.7
Parameters: set the zipfileset to add
Parameters: set the group (a fileset) to add
When we get here, the Zip file has been closed and all we need to do is to reset some globals.
This method will only reset globals that have been changed during execute(), it will not alter the attributes or nested child elements. If you want to reset the instance so that you can later zip a completely different set of files, you must use the reset method.
See Also: Zip
Parameters: zipFile the zip file
Returns: true for historic reasons
Throws: BuildException on error
Throws: BuildException on error
Throws: BuildException on error
Parameters: zOut the zip output stream
Throws: IOException on output error BuildException on other errors
Returns: Comment of the archive.
Since: Ant 1.6.3
Since: Ant 1.8.0
Since: Ant 1.8.0
Returns: the destination file
Since: Ant 1.5.2
Returns: the name of the encoding to use
Since: Ant 1.5.2
Since: Ant 1.8.0
Returns: compression level.
Since: Ant 1.7
If we are going to recreate the archive instead of updating
it, all resources should be considered as new, if a single one
is. Because of this, subclasses overriding this method must
call super.getResourcesToAdd
and indicate with the
third arg if they already know that the archive is
out-of-date.
Parameters: rcs The filesets to grab resources from zipFile intended archive file (may or may not exist) needsUpdate whether we already know that the archive is
out-of-date. Subclasses overriding this method are supposed to
set this value correctly in their call to
super.getResourcesToAdd
.
Returns: an array of resources to add for each fileset passed in as well as a flag that indicates whether the archive is uptodate.
Throws: BuildException if it likes
Since: Ant 1.8.0
If we are going to recreate the archive instead of updating
it, all resources should be considered as new, if a single one
is. Because of this, subclasses overriding this method must
call super.getResourcesToAdd
and indicate with the
third arg if they already know that the archive is
out-of-date.
This method first delegates to getNonFileSetResourceToAdd and then invokes the FileSet-arg version. All this to keep backwards compatibility for subclasses that don't know how to deal with non-FileSet ResourceCollections.
Parameters: rcs The resource collections to grab resources from zipFile intended archive file (may or may not exist) needsUpdate whether we already know that the archive is
out-of-date. Subclasses overriding this method are supposed to
set this value correctly in their call to
super.getResourcesToAdd
.
Returns: an array of resources to add for each fileset passed in as well as a flag that indicates whether the archive is uptodate.
Throws: BuildException if it likes
Since: Ant 1.7
If we are going to recreate the archive instead of updating
it, all resources should be considered as new, if a single one
is. Because of this, subclasses overriding this method must
call super.getResourcesToAdd
and indicate with the
third arg if they already know that the archive is
out-of-date.
Parameters: filesets The filesets to grab resources from zipFile intended archive file (may or may not exist) needsUpdate whether we already know that the archive is
out-of-date. Subclasses overriding this method are supposed to
set this value correctly in their call to
super.getResourcesToAdd
.
Returns: an array of resources to add for each fileset passed in as well as a flag that indicates whether the archive is uptodate.
Throws: BuildException if it likes
Since: Ant 1.8.0
Included directories will precede included files.
Parameters: rcs an array of resource collections
Returns: the resources included
Since: Ant 1.7
Included directories will precede included files.
Parameters: filesets an array of filesets
Returns: the resources included
Since: Ant 1.5.2
Returns: true if executeMain has written to the zip file.
Parameters: zOut the zip output stream
Throws: IOException on output error BuildException on other errors
Returns: true if adding new files
Returns: true if the files are to be compressed
Since: Ant 1.5.2
Parameters: r the arrays to check
Returns: true if all individual arrays are empty
Since: Ant 1.5.2
Returns: true if either doubleFilePass
is false or skipWriting
is true.
Since: Ant 1.8.0
Returns: true if updating an existing archive
Since: Ant 1.8.0
Since: Ant 1.5
See Also: Zip
Parameters: orig the resources to filter
Returns: the filters resources
Since: Ant 1.8.0
Parameters: orig the resources to filter
Returns: the filters resources
Since: Ant 1.6
Parameters: orig the resources to filter
Returns: the filters resources
Since: Ant 1.8.0
Parameters: baseDir the base directory
Parameters: comment The content of the comment.
Since: Ant 1.6.3
Parameters: c if true, compress the files
Since: Ant 1.8.0
Since: Ant 1.8.0
Parameters: destFile The new destination File
Since: Ant 1.5
add
, preserve
or fail
.
Possible values are: add
(keep both
of the files); preserve
(keep the first version
of the file found); fail
halt a problem
Default for zip tasks is add
Parameters: df a Duplicate
enumerated value
For a list of possible values see http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html.
Parameters: encoding the encoding name
Defaults to false.
Since: Ant 1.8.0
Deprecated: since 1.5.x. Use setDestFile(File) instead.
This is the name/location of where to create the file.Parameters: file the path of the zipFile
Since: Ant 1.5
UNKNOWN: ignore="true"
Parameters: f if true, emulate sun's jar by not adding parent directories
Parameters: keep if true, keep the original compression
Since: Ant 1.6
Parameters: level compression level.
Since: Ant 1.7
Since: Ant 1.8.0
Zip archives store file modification times with a granularity of two seconds, so the times will either be rounded up or down. If you round down, the archive will always seem out-of-date when you rerun the task, so the default is to round up. Rounding up may lead to a different type of problems like JSPs inside a web archive that seem to be slightly more recent than precompiled pages, rendering precompilation useless.
Parameters: r a boolean
value
Since: Ant 1.6.2
Parameters: c if true, updates an existing zip file
Since: Ant 1.8.0
fail
(throw an exception
and halt the build); skip
(do not create
any archive, but issue a warning); create
(make an archive with no entries).
Default for zip tasks is skip
;
for jar tasks, create
.Parameters: we a WhenEmpty
enumerated value
Deprecated: since 1.5.x. Use setDestFile(File) instead.
This is the name/location of where to create the .zip file.Parameters: zipFile the path of the zipFile
UNKNOWN: ignore="true"
Parameters: dir the directort to add to the archive zOut the stream to write to vPath the name this entry shall have in the archive mode the Unix permissions to set.
Throws: IOException on error
Since: Ant 1.5.2
Parameters: dir the directory to add to the archive zOut the stream to write to vPath the name this entry shall have in the archive mode the Unix permissions to set. extra ZipExtraFields to add
Throws: IOException on error
Since: Ant 1.6.3
Parameters: dir the directory to add to the archive zOut the stream to write to vPath the name this entry shall have in the archive mode the Unix permissions to set. extra ZipExtraFields to add
Throws: IOException on error
Since: Ant 1.8.0
Parameters: in the stream to read data for the entry from. The caller of the method is responsible for closing the stream. zOut the stream to write to. vPath the name this entry shall have in the archive. lastModified last modification time for the entry. fromArchive the original archive we are copying this entry from, will be null if we are not copying from an archive. mode the Unix permissions to set.
Throws: IOException on error
Since: Ant 1.5.2
Parameters: in the stream to read data for the entry from. The caller of the method is responsible for closing the stream. zOut the stream to write to. vPath the name this entry shall have in the archive. lastModified last modification time for the entry. fromArchive the original archive we are copying this entry from, will be null if we are not copying from an archive. mode the Unix permissions to set. extra ZipExtraFields to add
Throws: IOException on error
Since: Ant 1.8.0
java.io.File
instances.
This implementation delegates to the six-arg version.
Parameters: file the file to add to the archive zOut the stream to write to vPath the name this entry shall have in the archive mode the Unix permissions to set.
Throws: IOException on error
Since: Ant 1.5.2