org.apache.tools.ant.types

Class ZipFileSet

public class ZipFileSet extends FileSet

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
static int	DEFAULT_DIR_MODE Default value for the dirmode attribute.
static int	DEFAULT_FILE_MODE Default value for the filemode attribute.

Constructor Summary
	ZipFileSet()
protected	ZipFileSet(FileSet fileset)
protected	ZipFileSet(ZipFileSet fileset)

Method Summary
Object	clone() Return a ZipFileSet that has the same properties as this one.
DirectoryScanner	getDirectoryScanner(Project p) Return the DirectoryScanner associated with this FileSet.
int	getDirMode(Project p)
int	getFileMode(Project p)
String	getFullpath(Project p) Return the full pathname of the single entry in this fileset.
String	getPrefix(Project p) Return the prefix prepended to entries in the zip file.
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
File	getSrc(Project p) Get the zip file from which entries will be extracted.
boolean	hasDirModeBeenSet() Whether the user has specified the mode explicitly.
boolean	hasFileModeBeenSet() Whether the user has specified the mode explicitly.
void	setDir(File dir) Set the directory for the fileset.
void	setDirMode(String octalString) A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion; optional, default=0755
void	setFileMode(String octalString) A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion; optional, default=0644
void	setFullpath(String fullpath) Set the full pathname of the single entry in this fileset.
void	setPrefix(String prefix) Prepend this prefix to the path for each zip entry.
void	setSrc(File srcFile) Set the source Zip file for the zipfileset.

Field Detail

DEFAULT_DIR_MODE

public static final int DEFAULT_DIR_MODE

Default value for the dirmode attribute.

Since: Ant 1.5.2

DEFAULT_FILE_MODE

public static final int DEFAULT_FILE_MODE

Default value for the filemode attribute.

Since: Ant 1.5.2

Constructor Detail

ZipFileSet

public ZipFileSet()

ZipFileSet

protected ZipFileSet(FileSet fileset)

ZipFileSet

protected ZipFileSet(ZipFileSet fileset)

Method Detail

clone

public Object clone()

Return a ZipFileSet that has the same properties as this one.

Since: Ant 1.6

getDirectoryScanner

public DirectoryScanner getDirectoryScanner(Project p)

Return the DirectoryScanner associated with this FileSet. If the ZipFileSet defines a source Zip file, then a ZipScanner is returned instead.

getDirMode

public int getDirMode(Project p)

Since: Ant 1.5.2

getFileMode

public int getFileMode(Project p)

Since: Ant 1.5.2

getFullpath

public String getFullpath(Project p)

Return the full pathname of the single entry in this fileset.

getPrefix

public String getPrefix(Project p)

Return the prefix prepended to entries in the zip file.

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

getSrc

public File getSrc(Project p)

Get the zip file from which entries will be extracted. References are not followed, since it is not possible to have a reference to a ZipFileSet, only to a FileSet.

hasDirModeBeenSet

public boolean hasDirModeBeenSet()

Whether the user has specified the mode explicitly.

Since: Ant 1.6

hasFileModeBeenSet

public boolean hasFileModeBeenSet()

Whether the user has specified the mode explicitly.

Since: Ant 1.6

setDir

public void setDir(File dir)

Set the directory for the fileset. Prevents both "dir" and "src" from being specified.

setDirMode

public void setDirMode(String octalString)

A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion; optional, default=0755

Since: Ant 1.5.2

setFileMode

public void setFileMode(String octalString)

A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion; optional, default=0644

Since: Ant 1.5.2

setFullpath

public void setFullpath(String fullpath)

Set the full pathname of the single entry in this fileset. Prevents both prefix and fullpath from being specified

Parameters: fullpath the full pathname of the single entry in this fileset.

setPrefix

public void setPrefix(String prefix)

Prepend this prefix to the path for each zip entry. Prevents both prefix and fullpath from being specified

Parameters: prefix The prefix to prepend to entries in the zip file.

setSrc

public void setSrc(File srcFile)

Set the source Zip file for the zipfileset. Prevents both "dir" and "src" from being specified.

Parameters: srcFile The zip file from which to extract entries.