org.apache.tools.ant.types

Class ZipFileSet

Implemented Interfaces:
Cloneable, ResourceCollection, SelectorContainer

public class ZipFileSet
extends ArchiveFileSet

A ZipFileSet is a FileSet with extra attributes useful in the context of Zip/Jar tasks. A ZipFileSet extends FileSets with the ability to extract a subset of the entries of a Zip file for inclusion in another Zip file. It also includes a prefix attribute which is prepended to each entry in the output Zip file. Since ant 1.6 ZipFileSet can be defined with an id and referenced in packaging tasks

Field Summary

Fields inherited from class org.apache.tools.ant.types.ArchiveFileSet

DEFAULT_DIR_MODE, DEFAULT_FILE_MODE

Fields inherited from class org.apache.tools.ant.types.DataType

checked, ref

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

ZipFileSet()
Constructor for ZipFileSet
ZipFileSet(FileSet fileset)
Constructor using a fileset arguement.
ZipFileSet(ZipFileSet fileset)
Constructor using a zipfileset arguement.

Method Summary

Object
clone()
Return a ZipFileSet that has the same properties as this one.
String
getEncoding()
Get the encoding used for this ZipFileSet.
protected AbstractFileSet
getRef(Project p)
A ZipFileset accepts another ZipFileSet or a FileSet as reference FileSets are often used by the war task for the lib attribute
protected ArchiveScanner
newArchiveScanner()
Return a new archive scanner based on this one.
void
setEncoding(String enc)
Set the encoding used for this ZipFileSet.

Methods inherited from class org.apache.tools.ant.types.ArchiveFileSet

addConfigured, clone, configureFileSet, getDirMode, getDirMode, getDirectoryScanner, getFileMode, getFileMode, getFullpath, getFullpath, getPrefix, getPrefix, getSrc, getSrc, hasDirModeBeenSet, hasFileModeBeenSet, integerSetDirMode, integerSetFileMode, isFilesystemOnly, iterator, newArchiveScanner, setDir, setDirMode, setFileMode, setFullpath, setPrefix, setSrc, setSrcResource, size, toString

Methods inherited from class org.apache.tools.ant.types.FileSet

clone, isFilesystemOnly, iterator, size

Methods inherited from class org.apache.tools.ant.types.AbstractFileSet

add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendExcludes, appendIncludes, appendSelector, clone, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDefaultexcludes, getDir, getDir, getDirectoryScanner, getDirectoryScanner, getRef, getSelectors, hasPatterns, hasSelectors, isCaseSensitive, isFollowSymlinks, mergeExcludes, mergeIncludes, mergePatterns, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setDir, setExcludes, setExcludesfile, setFile, setFollowSymlinks, setIncludes, setIncludesfile, setRefid, setupDirectoryScanner, setupDirectoryScanner, toString

Methods inherited from class org.apache.tools.ant.types.DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, setChecked, setRefid, toString, tooManyAttributes

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Constructor Details

ZipFileSet

public ZipFileSet()
Constructor for ZipFileSet

ZipFileSet

protected ZipFileSet(FileSet fileset)
Constructor using a fileset arguement.
Parameters:
fileset - the fileset to use

ZipFileSet

protected ZipFileSet(ZipFileSet fileset)
Constructor using a zipfileset arguement.
Parameters:
fileset - the zipfileset to use

Method Details

clone

public Object clone()
Return a ZipFileSet that has the same properties as this one.
Overrides:
clone in interface ArchiveFileSet
Returns:
the cloned zipFileSet

getEncoding

public String getEncoding()
Get the encoding used for this ZipFileSet.
Returns:
String encoding.
Since:
Ant 1.7

getRef

protected AbstractFileSet getRef(Project p)
A ZipFileset accepts another ZipFileSet or a FileSet as reference FileSets are often used by the war task for the lib attribute
Overrides:
getRef in interface AbstractFileSet
Parameters:
p - the project to use
Returns:
the abstract fileset instance

newArchiveScanner

protected ArchiveScanner newArchiveScanner()
Return a new archive scanner based on this one.
Overrides:
newArchiveScanner in interface ArchiveFileSet
Returns:
a new ZipScanner with the same encoding as this one.

setEncoding

public void setEncoding(String enc)
Set the encoding used for this ZipFileSet.
Parameters:
enc - encoding as String.
Since:
Ant 1.7