Package org.apache.tools.ant.types
Class ArchiveFileSet
- java.lang.Object
- 
- org.apache.tools.ant.ProjectComponent
- 
- org.apache.tools.ant.types.DataType
- 
- org.apache.tools.ant.types.AbstractFileSet
- 
- org.apache.tools.ant.types.FileSet
- 
- org.apache.tools.ant.types.ArchiveFileSet
 
 
 
 
 
- 
- All Implemented Interfaces:
- java.lang.Cloneable,- java.lang.Iterable<Resource>,- ResourceCollection,- SelectorContainer
 - Direct Known Subclasses:
- TarFileSet,- ZipFileSet
 
 public abstract class ArchiveFileSet extends FileSet A ArchiveFileSet is a FileSet with extra attributes useful in the context of archiving tasks. It includes a prefix attribute which is prepended to each entry in the output archive file as well as a fullpath attribute. It also supports Unix file permissions for files and directories.- Since:
- Ant 1.7
 
- 
- 
Field SummaryFields Modifier and Type Field Description static intDEFAULT_DIR_MODEDefault value for the dirmode attribute.static intDEFAULT_FILE_MODEDefault value for the filemode attribute.- 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Modifier Constructor Description ArchiveFileSet()Constructor for ArchiveFileSetprotectedArchiveFileSet(ArchiveFileSet fileset)Constructor using a archive fileset argument.protectedArchiveFileSet(FileSet fileset)Constructor using a fileset argument.
 - 
Method SummaryModifier and Type Method Description voidaddConfigured(ResourceCollection a)Set the source Archive file for the archivefileset.java.lang.Objectclone()Return a ArchiveFileSet that has the same properties as this one.protected voidconfigureFileSet(ArchiveFileSet zfs)A ArchiveFileset accepts another ArchiveFileSet or a FileSet as reference FileSets are often used by the war task for the lib attributeprotected voiddieOnCircularReference(java.util.Stack<java.lang.Object> stk, Project p)Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).DirectoryScannergetDirectoryScanner(Project p)Return the DirectoryScanner associated with this FileSet.intgetDirMode()Deprecated.since 1.7.intgetDirMode(Project p)Get the dir mode of the archive filesetjava.lang.StringgetEncoding()Get the encoding used for this ZipFileSet.intgetFileMode()Deprecated.since 1.7.intgetFileMode(Project p)Get the mode of the archive filesetjava.lang.StringgetFullpath()Deprecated.since 1.7.java.lang.StringgetFullpath(Project p)Return the full pathname of the single entry in this fileset.java.lang.StringgetPrefix()Deprecated.since 1.7.java.lang.StringgetPrefix(Project p)Return the prefix prepended to entries in the archive file.protected AbstractFileSetgetRef()Performs the check for circular references and returns the referenced object.java.io.FilegetSrc()Get the archive file from which entries will be extracted.java.io.FilegetSrc(Project p)Get the archive from which entries will be extracted.booleanhasDirModeBeenSet()Whether the user has specified the mode explicitly.booleanhasFileModeBeenSet()Whether the user has specified the mode explicitly.voidintegerSetDirMode(int mode)specify the user, group and other modes in the standard Unix fashion; optional, default=0755voidintegerSetFileMode(int mode)specify the user, group and other modes in the standard Unix fashion; optional, default=0644booleanisFilesystemOnly()Indicate whether this ResourceCollection is composed entirely of Resources accessible via local filesystem conventions.java.util.Iterator<Resource>iterator()Fulfill the ResourceCollection contract.protected abstract ArchiveScannernewArchiveScanner()Creates a scanner for this type of archive.voidsetDir(java.io.File dir)Set the directory for the fileset.voidsetDirMode(java.lang.String octalString)A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion; optional, default=0755voidsetEncoding(java.lang.String enc)Set the encoding used for this ZipFileSet.voidsetErrorOnMissingArchive(boolean errorOnMissingArchive)Sets whether an error is thrown if an archive does not exist.voidsetFileMode(java.lang.String octalString)A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion; optional, default=0644voidsetFullpath(java.lang.String fullpath)Set the full pathname of the single entry in this fileset.voidsetPrefix(java.lang.String prefix)Prepend this prefix to the path for each archive entry.voidsetSrc(java.io.File srcFile)Set the source Archive file for the archivefileset.voidsetSrcResource(Resource src)Set the source Archive file for the archivefileset.intsize()Fulfill the ResourceCollection contract.java.lang.StringtoString()For file-based archivefilesets, return the same as for normal filesets; else just return the path of the zip.- 
Methods inherited from class org.apache.tools.ant.types.AbstractFileSetadd, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addExecutable, addFilename, addMajority, addModified, addNone, addNot, addOr, addOwnedBy, addPosixGroup, addPosixPermissions, addPresent, addReadable, addSelector, addSize, addSymlink, addType, addWritable, appendExcludes, appendIncludes, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDefaultexcludes, getDir, getDir, getDirectoryScanner, getErrorOnMissingDir, getMaxLevelsOfSymlinks, getSelectors, hasPatterns, hasSelectors, isCaseSensitive, isFollowSymlinks, mergeExcludes, mergeIncludes, mergePatterns, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setErrorOnMissingDir, setExcludes, setExcludesfile, setFile, setFollowSymlinks, setIncludes, setIncludesfile, setMaxLevelsOfSymlinks, setRefid, setupDirectoryScanner, setupDirectoryScanner
 - 
Methods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
 - 
Methods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
 - 
Methods inherited from class java.lang.Objectequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface org.apache.tools.ant.types.ResourceCollectionisEmpty, stream
 
- 
 
- 
- 
- 
Field Detail- 
DEFAULT_DIR_MODEpublic static final int DEFAULT_DIR_MODE Default value for the dirmode attribute.- Since:
- Ant 1.5.2
- See Also:
- Constant Field Values
 
 - 
DEFAULT_FILE_MODEpublic static final int DEFAULT_FILE_MODE Default value for the filemode attribute.- Since:
- Ant 1.5.2
- See Also:
- Constant Field Values
 
 
- 
 - 
Constructor Detail- 
ArchiveFileSetpublic ArchiveFileSet() Constructor for ArchiveFileSet
 - 
ArchiveFileSetprotected ArchiveFileSet(FileSet fileset) Constructor using a fileset argument.- Parameters:
- fileset- the fileset to use
 
 - 
ArchiveFileSetprotected ArchiveFileSet(ArchiveFileSet fileset) Constructor using a archive fileset argument.- Parameters:
- fileset- the archivefileset to use
 
 
- 
 - 
Method Detail- 
setDirpublic void setDir(java.io.File dir) throws BuildExceptionSet the directory for the fileset.- Overrides:
- setDirin class- AbstractFileSet
- Parameters:
- dir- the directory for the fileset
- Throws:
- BuildException- on error
 
 - 
addConfiguredpublic void addConfigured(ResourceCollection a) Set the source Archive file for the archivefileset. Prevents both "dir" and "src" from being specified.- Parameters:
- a- the archive as a single element Resource collection.
 
 - 
setSrcpublic void setSrc(java.io.File srcFile) Set the source Archive file for the archivefileset. Prevents both "dir" and "src" from being specified.- Parameters:
- srcFile- The archive from which to extract entries.
 
 - 
setSrcResourcepublic void setSrcResource(Resource src) Set the source Archive file for the archivefileset. Prevents both "dir" and "src" from being specified.- Parameters:
- src- The archive from which to extract entries.
 
 - 
getSrcpublic java.io.File getSrc(Project p) Get the archive from which entries will be extracted.- Parameters:
- p- the project to use
- Returns:
- the source file
 
 - 
setErrorOnMissingArchivepublic void setErrorOnMissingArchive(boolean errorOnMissingArchive) Sets whether an error is thrown if an archive does not exist.- Parameters:
- errorOnMissingArchive- true if missing archives cause errors, false if not.
- Since:
- Ant 1.8.0
 
 - 
getSrcpublic java.io.File getSrc() Get the archive file from which entries will be extracted.- Returns:
- the archive in case the archive is a file, null otherwise.
 
 - 
getRefprotected AbstractFileSet getRef() Performs the check for circular references and returns the referenced object. This method must be overridden together withgetRef(Project)providing implementations containing the special support for FileSet references, which can be handled by all ArchiveFileSets. NB! This method cannot be implemented in AbstractFileSet in order to allow FileSet and DirSet to implement it as a private method.- Returns:
- the dereferenced object.
- Throws:
- BuildException- if the reference is invalid (circular ref, wrong class, etc).
 
 - 
setPrefixpublic void setPrefix(java.lang.String prefix) Prepend this prefix to the path for each archive entry. Prevents both prefix and fullpath from being specified- Parameters:
- prefix- The prefix to prepend to entries in the archive file.
 
 - 
getPrefixpublic java.lang.String getPrefix(Project p) Return the prefix prepended to entries in the archive file.- Parameters:
- p- the project to use
- Returns:
- the prefix
 
 - 
setFullpathpublic void setFullpath(java.lang.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.
 
 - 
getFullpathpublic java.lang.String getFullpath(Project p) Return the full pathname of the single entry in this fileset.- Parameters:
- p- the project to use
- Returns:
- the full path
 
 - 
setEncodingpublic void setEncoding(java.lang.String enc) Set the encoding used for this ZipFileSet.- Parameters:
- enc- encoding as String.
- Since:
- Ant 1.9.5
 
 - 
getEncodingpublic java.lang.String getEncoding() Get the encoding used for this ZipFileSet.- Returns:
- String encoding.
- Since:
- Ant 1.9.5
 
 - 
newArchiveScannerprotected abstract ArchiveScanner newArchiveScanner() Creates a scanner for this type of archive.- Returns:
- the scanner.
 
 - 
getDirectoryScannerpublic DirectoryScanner getDirectoryScanner(Project p) Return the DirectoryScanner associated with this FileSet. If the ArchiveFileSet defines a source Archive file, then an ArchiveScanner is returned instead.- Overrides:
- getDirectoryScannerin class- AbstractFileSet
- Parameters:
- p- the project to use
- Returns:
- a directory scanner
 
 - 
iteratorpublic java.util.Iterator<Resource> iterator() Fulfill the ResourceCollection contract.
 - 
sizepublic int size() Fulfill the ResourceCollection contract.- Specified by:
- sizein interface- ResourceCollection
- Overrides:
- sizein class- FileSet
- Returns:
- size of the collection as int.
- Since:
- Ant 1.7
 
 - 
isFilesystemOnlypublic boolean isFilesystemOnly() Indicate whether this ResourceCollection is composed entirely of Resources accessible via local filesystem conventions. If true, all Resources returned from this ResourceCollection should be instances of FileResource.- Specified by:
- isFilesystemOnlyin interface- ResourceCollection
- Overrides:
- isFilesystemOnlyin class- FileSet
- Returns:
- whether this is a filesystem-only resource collection.
- Since:
- Ant 1.7
 
 - 
setFileModepublic void setFileMode(java.lang.String octalString) A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion; optional, default=0644- Parameters:
- octalString- a- Stringvalue
 
 - 
integerSetFileModepublic void integerSetFileMode(int mode) specify the user, group and other modes in the standard Unix fashion; optional, default=0644We use the strange name so this method doesn't appear in IntrospectionHelpers list of attribute setters. - Parameters:
- mode- a- intvalue
- Since:
- Ant 1.7
 
 - 
getFileModepublic int getFileMode(Project p) Get the mode of the archive fileset- Parameters:
- p- the project to use
- Returns:
- the mode
 
 - 
hasFileModeBeenSetpublic boolean hasFileModeBeenSet() Whether the user has specified the mode explicitly.- Returns:
- true if it has been set
 
 - 
setDirModepublic void setDirMode(java.lang.String octalString) A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion; optional, default=0755- Parameters:
- octalString- a- Stringvalue
 
 - 
integerSetDirModepublic void integerSetDirMode(int mode) specify the user, group and other modes in the standard Unix fashion; optional, default=0755We use the strange name so this method doesn't appear in IntrospectionHelpers list of attribute setters. - Parameters:
- mode- a- intvalue
- Since:
- Ant 1.7
 
 - 
getDirModepublic int getDirMode(Project p) Get the dir mode of the archive fileset- Parameters:
- p- the project to use
- Returns:
- the mode
 
 - 
hasDirModeBeenSetpublic boolean hasDirModeBeenSet() Whether the user has specified the mode explicitly.- Returns:
- true if it has been set
 
 - 
configureFileSetprotected 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- Parameters:
- zfs- the project to use
 
 - 
clonepublic java.lang.Object clone() Return a ArchiveFileSet that has the same properties as this one.
 - 
toStringpublic java.lang.String toString() For file-based archivefilesets, return the same as for normal filesets; else just return the path of the zip.- Overrides:
- toStringin class- AbstractFileSet
- Returns:
- for file based archivefilesets, included files as a list of semicolon-separated filenames. else just the name of the zip.
 
 - 
getPrefix@Deprecated public java.lang.String getPrefix() Deprecated.since 1.7.Return the prefix prepended to entries in the archive file.- Returns:
- the prefix.
 
 - 
getFullpath@Deprecated public java.lang.String getFullpath() Deprecated.since 1.7.Return the full pathname of the single entryZ in this fileset.- Returns:
- the full pathname.
 
 - 
getFileMode@Deprecated public int getFileMode() Deprecated.since 1.7.- Returns:
- the file mode.
 
 - 
getDirMode@Deprecated public int getDirMode() Deprecated.since 1.7.- Returns:
- the dir mode.
 
 - 
dieOnCircularReferenceprotected void dieOnCircularReference(java.util.Stack<java.lang.Object> stk, Project p) throws BuildExceptionDescription copied from class:DataTypeCheck to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).If one is included, throw a BuildException created by circularReference.This implementation is appropriate only for a DataType that cannot hold other DataTypes as children. The general contract of this method is that it shouldn't do anything if DataType.checkedis true and set it to true on exit.- Overrides:
- dieOnCircularReferencein class- AbstractFileSet
- Parameters:
- stk- the stack of references to check.
- p- the project to use to dereference the references.
- Throws:
- BuildException- on error.
 
 
- 
 
-