org.apache.tools.ant.types
public abstract class ArchiveFileSet extends FileSet
Since: Ant 1.7
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 | |
---|---|
ArchiveFileSet() Constructor for ArchiveFileSet | |
protected | ArchiveFileSet(FileSet fileset)
Constructor using a fileset arguement. |
protected | ArchiveFileSet(ArchiveFileSet fileset)
Constructor using a archive fileset arguement. |
Method Summary | |
---|---|
void | addConfigured(ResourceCollection a)
Set the source Archive file for the archivefileset. |
Object | clone()
Return a ArchiveFileSet that has the same properties
as this one. |
protected void | configureFileSet(ArchiveFileSet zfs)
A ArchiveFileset accepts another ArchiveFileSet or a FileSet as reference
FileSets are often used by the war task for the lib attribute |
protected void | dieOnCircularReference(Stack stk, Project p) |
protected Object | getCheckedRef(Project p)
Performs the check for circular references and returns the
referenced object.
|
DirectoryScanner | getDirectoryScanner(Project p)
Return the DirectoryScanner associated with this FileSet.
|
int | getDirMode(Project p)
Get the dir mode of the archive fileset |
int | getDirMode() |
int | getFileMode(Project p)
Get the mode of the archive fileset |
int | getFileMode() |
String | getFullpath(Project p)
Return the full pathname of the single entry in this fileset. |
String | getFullpath()
Return the full pathname of the single entryZ in this fileset. |
String | getPrefix(Project p)
Return the prefix prepended to entries in the archive file. |
String | getPrefix()
Return the prefix prepended to entries in the archive file. |
File | getSrc(Project p)
Get the archive from which entries will be extracted. |
File | getSrc()
Get the archive 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 | integerSetDirMode(int mode)
specify the user, group and
other modes in the standard Unix fashion;
optional, default=0755
We use the strange name so this method doesn't appear in IntrospectionHelpers list of attribute setters. |
void | integerSetFileMode(int mode)
specify the user, group and
other modes in the standard Unix fashion;
optional, default=0644
We use the strange name so this method doesn't appear in IntrospectionHelpers list of attribute setters. |
boolean | isFilesystemOnly()
Indicate whether this ResourceCollection is composed entirely of
Resources accessible via local filesystem conventions. |
Iterator | iterator()
Fulfill the ResourceCollection contract. |
protected abstract ArchiveScanner | newArchiveScanner()
Creates a scanner for this type of archive. |
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 | setErrorOnMissingArchive(boolean errorOnMissingArchive)
Sets whether an error is thrown if an archive does not exist.
|
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 archive entry.
|
void | setSrc(File srcFile)
Set the source Archive file for the archivefileset. |
void | setSrcResource(Resource src)
Set the source Archive file for the archivefileset. |
int | size()
Fulfill the ResourceCollection contract. |
String | toString()
For file-based archivefilesets, return the same as for normal filesets;
else just return the path of the zip. |
Since: Ant 1.5.2
Since: Ant 1.5.2
Parameters: fileset the fileset to use
Parameters: fileset the archivefileset to use
Parameters: a the archive as a single element Resource collection.
Returns: the cloned archiveFileSet
Since: Ant 1.6
Parameters: zfs the project to use
Parameters: p the Ant Project instance against which to resolve references.
Returns: the dereferenced object.
Throws: BuildException if the reference is invalid (circular ref, wrong class, etc).
Since: Ant 1.8
Parameters: p the project to use
Returns: a directory scanner
Parameters: p the project to use
Returns: the mode
Deprecated: since 1.7.
Returns: the dir mode.
Parameters: p the project to use
Returns: the mode
Deprecated: since 1.7.
Returns: the file mode.
Parameters: p the project to use
Returns: the full path
Deprecated: since 1.7.
Return the full pathname of the single entryZ in this fileset.Returns: the full pathname.
Parameters: p the project to use
Returns: the prefix
Deprecated: since 1.7.
Return the prefix prepended to entries in the archive file.Returns: the prefix.
Parameters: p the project to use
Returns: the source file
Returns: the archive in case the archive is a file, null otherwise.
Returns: true if it has been set
Returns: true if it has been set
We use the strange name so this method doesn't appear in IntrospectionHelpers list of attribute setters.
Parameters: mode a int
value
Since: Ant 1.7
We use the strange name so this method doesn't appear in IntrospectionHelpers list of attribute setters.
Parameters: mode a int
value
Since: Ant 1.7
Returns: whether this is a filesystem-only resource collection.
Since: Ant 1.7
Returns: Iterator of Resources.
Since: Ant 1.7
Returns: the scanner.
Parameters: dir the directory for the fileset
Throws: BuildException on error
Parameters: octalString a String
value
Parameters: errorOnMissingArchive true if missing archives cause errors, false if not.
Since: Ant 1.8.0
Parameters: octalString a String
value
Parameters: fullpath the full pathname of the single entry in this fileset.
Parameters: prefix The prefix to prepend to entries in the archive file.
Parameters: srcFile The archive from which to extract entries.
Parameters: src The archive from which to extract entries.
Returns: size of the collection as int.
Since: Ant 1.7
Returns: for file based archivefilesets, included files as a list of semicolon-separated filenames. else just the name of the zip.