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:

Cloneable, 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 Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_DIR_MODE	Default value for the dirmode attribute.
static final int	DEFAULT_FILE_MODE	Default value for the filemode attribute.

Fields inherited from class DataType

checked, ref

Modifier and Type	Field	Description
protected boolean	checked	Deprecated. since 1.7.
protected Reference	ref	Deprecated. since 1.7.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Modifier	Constructor	Description
	ArchiveFileSet()	Constructor for ArchiveFileSet
protected	ArchiveFileSet(ArchiveFileSet fileset)	Constructor using a archive fileset argument.
protected	ArchiveFileSet(FileSet fileset)	Constructor using a fileset argument.

Method Summary

Modifier and Type	Method	Description
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<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).
DirectoryScanner	getDirectoryScanner(Project p)	Return the DirectoryScanner associated with this FileSet.
int	getDirMode()	Deprecated. since 1.7.
int	getDirMode(Project p)	Get the dir mode of the archive fileset
String	getEncoding()	Get the encoding used for this ZipFileSet.
int	getFileMode()	Deprecated. since 1.7.
int	getFileMode(Project p)	Get the mode of the archive fileset
String	getFullpath()	Deprecated. since 1.7.
String	getFullpath(Project p)	Return the full pathname of the single entry in this fileset.
String	getPrefix()	Deprecated. since 1.7.
String	getPrefix(Project p)	Return the prefix prepended to entries in the archive file.
protected AbstractFileSet	getRef()	Performs the check for circular references and returns the referenced object.
File	getSrc()	Get the archive file from which entries will be extracted.
File	getSrc(Project p)	Get the archive 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
void	integerSetFileMode(int mode)	specify the user, group and other modes in the standard Unix fashion; optional, default=0644
boolean	isFilesystemOnly()	Indicate whether this ResourceCollection is composed entirely of Resources accessible via local filesystem conventions.
Iterator<Resource>	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	setEncoding(String enc)	Set the encoding used for this ZipFileSet.
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.

Methods inherited from class FileSet

getRef

Modifier and Type	Method	Description
protected AbstractFileSet	getRef(Project p)	Performs the check for circular references and returns the referenced FileSet.

Methods inherited from class AbstractFileSet

add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addExecutable, addFilename, addMajority, addModified, addNone, addNot, addOr, addOwnedBy, addPosixGroup, addPosixPermissions, addPresent, addReadable, addSelector, addSize, addSymlink, addType, addWindowsJunction, 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

Modifier and Type	Method	Description
void	add(FileSelector selector)	Add an arbitrary selector.
void	addAnd(AndSelector selector)	Add an "And" selector entry on the selector list.
void	addContains(ContainsSelector selector)	Add a contains selector entry on the selector list.
void	addContainsRegexp(ContainsRegexpSelector selector)	Add a regular expression selector entry on the selector list.
void	addCustom(ExtendSelector selector)	Add an extended selector entry on the selector list.
void	addDate(DateSelector selector)	Add a selector date entry on the selector list.
void	addDepend(DependSelector selector)	Add a depends selector entry on the selector list.
void	addDepth(DepthSelector selector)	Add a depth selector entry on the selector list.
void	addDifferent(DifferentSelector selector)	Add a DifferentSelector entry on the selector list.
void	addExecutable(ExecutableSelector e)
void	addFilename(FilenameSelector selector)	Add a selector filename entry on the selector list.
void	addMajority(MajoritySelector selector)	Add a majority selector entry on the selector list.
void	addModified(ModifiedSelector selector)	Add the modified selector.
void	addNone(NoneSelector selector)	Add a "None" selector entry on the selector list.
void	addNot(NotSelector selector)	Add a "Not" selector entry on the selector list.
void	addOr(OrSelector selector)	Add an "Or" selector entry on the selector list.
void	addOwnedBy(OwnedBySelector o)
void	addPosixGroup(PosixGroupSelector o)
void	addPosixPermissions(PosixPermissionsSelector o)
void	addPresent(PresentSelector selector)	Add a present selector entry on the selector list.
void	addReadable(ReadableSelector r)
void	addSelector(SelectSelector selector)	Add a "Select" selector entry on the selector list.
void	addSize(SizeSelector selector)	Add a selector size entry on the selector list.
void	addSymlink(SymlinkSelector e)
void	addType(TypeSelector selector)	Add a selector type entry on the selector list.
void	addWindowsJunction(WindowsJunctionSelector e)
void	addWritable(WritableSelector w)
void	appendExcludes(String[] excludes)	Appends excludes to the current list of exclude patterns.
void	appendIncludes(String[] includes)	Appends includes to the current list of include patterns.
void	appendSelector(FileSelector selector)	Add a new selector into this container.
PatternSet.NameEntry	createExclude()	Add a name entry to the exclude list.
PatternSet.NameEntry	createExcludesFile()	Add a name entry to the excludes files list.
PatternSet.NameEntry	createInclude()	Add a name entry to the include list.
PatternSet.NameEntry	createIncludesFile()	Add a name entry to the include files list.
PatternSet	createPatternSet()	Creates a nested patternset.
boolean	getDefaultexcludes()	Whether default exclusions should be used or not.
File	getDir()	Retrieves the base-directory for this instance.
File	getDir(Project p)	Retrieves the base-directory for this instance.
DirectoryScanner	getDirectoryScanner()	Returns the directory scanner needed to access the files to process.
boolean	getErrorOnMissingDir()	Gets whether an error is/should be thrown if the base directory does not exist.
int	getMaxLevelsOfSymlinks()	The maximum number of times a symbolic link or Windows junctions may be followed during a scan.
FileSelector[]	getSelectors(Project p)	Returns the set of selectors as an array.
boolean	hasPatterns()	Indicates whether there are any patterns here.
boolean	hasSelectors()	Indicates whether there are any selectors here.
boolean	isCaseSensitive()	Find out if the fileset is case sensitive.
boolean	isFollowSymlinks()	Find out if the fileset wants to follow symbolic links or Windows junctions.
String[]	mergeExcludes(Project p)	Get the merged exclude patterns for this AbstractFileSet.
String[]	mergeIncludes(Project p)	Get the merged include patterns for this AbstractFileSet.
PatternSet	mergePatterns(Project p)	Get the merged patterns for this AbstractFileSet.
int	selectorCount()	Gives the count of the number of selectors in this container.
Enumeration<FileSelector>	selectorElements()	Returns an enumerator for accessing the set of selectors.
void	setCaseSensitive(boolean caseSensitive)	Sets case sensitivity of the file system.
void	setDefaultexcludes(boolean useDefaultExcludes)	Sets whether default exclusions should be used or not.
void	setErrorOnMissingDir(boolean errorOnMissingDir)	Sets whether an error is thrown if a directory does not exist.
void	setExcludes(String excludes)	Appends excludes to the current list of exclude patterns.
void	setExcludesfile(File excl)	Sets the File containing the excludes patterns.
void	setFile(File file)	Creates a single file fileset.
void	setFollowSymlinks(boolean followSymlinks)	Sets whether or not symbolic links or Windows junctions should be followed.
void	setIncludes(String includes)	Appends includes to the current list of include patterns.
void	setIncludesfile(File incl)	Sets the File containing the includes patterns.
void	setMaxLevelsOfSymlinks(int max)	The maximum number of times a symbolic link or Windows junctions may be followed during a scan.
void	setRefid(Reference r)	Makes this instance in effect a reference to another instance.
void	setupDirectoryScanner(FileScanner ds)	Set up the specified directory scanner against this AbstractFileSet's Project.
void	setupDirectoryScanner(FileScanner ds, Project p)	Set up the specified directory scanner against the specified project.

Methods inherited from class DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes

Modifier and Type	Method	Description
protected void	checkAttributesAllowed()	check that it is ok to set attributes, i.e that no reference is defined
protected void	checkChildrenAllowed()	check that it is ok to add children, i.e that no reference is defined
protected BuildException	circularReference()	Creates an exception that indicates the user has generated a loop of data types referencing each other.
protected void	dieOnCircularReference()	Convenience method.
protected void	dieOnCircularReference(Project p)	Convenience method.
protected <T> T	getCheckedRef()	Deprecated. use getCheckedRef(Class)
protected <T> T	getCheckedRef(Class<T> requiredClass)	Performs the check for circular references and returns the referenced object.
protected <T> T	getCheckedRef(Class<T> requiredClass, String dataTypeName)	Performs the check for circular references and returns the referenced object.
protected <T> T	getCheckedRef(Class<T> requiredClass, String dataTypeName, Project project)	Performs the check for circular references and returns the referenced object.
protected <T> T	getCheckedRef(Project p)	Deprecated. use getCheckedRef(Class)
protected String	getDataTypeName()	Gets as descriptive as possible a name used for this datatype instance.
Reference	getRefid()	get the reference set on this object
static void	invokeCircularReferenceCheck(DataType dt, Stack<Object> stk, Project p)	Allow DataTypes outside org.apache.tools.ant.types to indirectly call dieOnCircularReference on nested DataTypes.
protected boolean	isChecked()	The flag that is used to indicate that circular references have been checked.
boolean	isReference()	Has the refid attribute of this element been set?
protected BuildException	noChildrenAllowed()	Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set.
static void	pushAndInvokeCircularReferenceCheck(DataType dt, Stack<Object> stk, Project p)	Allow DataTypes outside org.apache.tools.ant.types to indirectly call dieOnCircularReference on nested DataTypes.
protected void	setChecked(boolean checked)	Set the flag that is used to indicate that circular references have been checked.
protected BuildException	tooManyAttributes()	Creates an exception that indicates that refid has to be the only attribute if it is set.

Methods inherited from class ProjectComponent

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

Modifier and Type	Method	Description
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface ResourceCollection

isEmpty, stream

Modifier and Type	Method	Description
default boolean	isEmpty()	Learn whether this ResourceCollection is empty.
default Stream<? extends Resource>	stream()	Return a Stream over this ResourceCollection.

Field Details

DEFAULT_DIR_MODE

public static final int DEFAULT_DIR_MODE

Default value for the dirmode attribute.

Since:

Ant 1.5.2

See Also:

• Constant Field Values

DEFAULT_FILE_MODE

public static final int DEFAULT_FILE_MODE

Default value for the filemode attribute.

Since:

Ant 1.5.2

See Also:

• Constant Field Values

Constructor Details

ArchiveFileSet

public ArchiveFileSet()

Constructor for ArchiveFileSet

ArchiveFileSet

protected ArchiveFileSet(FileSet fileset)

Constructor using a fileset argument.

Parameters:

fileset - the fileset to use

ArchiveFileSet

protected ArchiveFileSet(ArchiveFileSet fileset)

Constructor using a archive fileset argument.

Parameters:

fileset - the archivefileset to use

Method Details

setDir

public void setDir(File dir)
            throws BuildException

Set the directory for the fileset.

Overrides:

setDir in class AbstractFileSet

Parameters:

dir - the directory for the fileset

Throws:

BuildException - on error

addConfigured

public 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.

setSrc

public void setSrc(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.

setSrcResource

public 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.

getSrc

public File getSrc(Project p)

Get the archive from which entries will be extracted.

Parameters:

p - the project to use

Returns:

the source file

setErrorOnMissingArchive

public 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

getSrc

public File getSrc()

Get the archive file from which entries will be extracted.

Returns:

the archive in case the archive is a file, null otherwise.

getRef

protected AbstractFileSet getRef()

Performs the check for circular references and returns the referenced object. This method must be overridden together with getRef(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).

setPrefix

public void setPrefix(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.

getPrefix

public String getPrefix(Project p)

Return the prefix prepended to entries in the archive file.

Parameters:

p - the project to use

Returns:

the prefix

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.

getFullpath

public 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

setEncoding

public void setEncoding(String enc)

Set the encoding used for this ZipFileSet.

Parameters:

enc - encoding as String.

Since:

Ant 1.9.5

getEncoding

public String getEncoding()

Get the encoding used for this ZipFileSet.

Returns:

String encoding.

Since:

Ant 1.9.5

newArchiveScanner

protected abstract ArchiveScanner newArchiveScanner()

Creates a scanner for this type of archive.

Returns:

the scanner.

getDirectoryScanner

public 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:

getDirectoryScanner in class AbstractFileSet

Parameters:

p - the project to use

Returns:

a directory scanner

iterator

public Iterator<Resource> iterator()

Fulfill the ResourceCollection contract.

Specified by:

iterator in interface Iterable<Resource>

Overrides:

iterator in class FileSet

Returns:

Iterator of Resources.

Since:

Ant 1.7

size

public int size()

Fulfill the ResourceCollection contract.

Specified by:

size in interface ResourceCollection

Overrides:

size in class FileSet

Returns:

size of the collection as int.

Since:

Ant 1.7

isFilesystemOnly

public 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:

isFilesystemOnly in interface ResourceCollection

Overrides:

isFilesystemOnly in class FileSet

Returns:

whether this is a filesystem-only resource collection.

Since:

Ant 1.7

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

Parameters:

octalString - a String value

integerSetFileMode

public 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.

Parameters:

mode - a int value

Since:

Ant 1.7

getFileMode

public int getFileMode(Project p)

Get the mode of the archive fileset

Parameters:

p - the project to use

Returns:

the mode

hasFileModeBeenSet

public boolean hasFileModeBeenSet()

Whether the user has specified the mode explicitly.

Returns:

true if it has been set

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

Parameters:

octalString - a String value

integerSetDirMode

public 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.

Parameters:

mode - a int value

Since:

Ant 1.7

getDirMode

public int getDirMode(Project p)

Get the dir mode of the archive fileset

Parameters:

p - the project to use

Returns:

the mode

hasDirModeBeenSet

public boolean hasDirModeBeenSet()

Whether the user has specified the mode explicitly.

Returns:

true if it has been set

configureFileSet

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

Parameters:

zfs - the project to use

clone

public Object clone()

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

Overrides:

clone in class FileSet

Returns:

the cloned archiveFileSet

Since:

Ant 1.6

toString

public String toString()

For file-based archivefilesets, return the same as for normal filesets; else just return the path of the zip.

Overrides:

toString in 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 String getPrefix()

Deprecated.

since 1.7.

Return the prefix prepended to entries in the archive file.

Returns:

the prefix.

getFullpath

@Deprecated
public 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.

dieOnCircularReference

protected void dieOnCircularReference(Stack<Object> stk,
 Project p)
                               throws BuildException

Description copied from class: DataType

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).

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.checked is true and set it to true on exit.

Overrides:

dieOnCircularReference in class AbstractFileSet

Parameters:

stk - the stack of references to check.

p - the project to use to dereference the references.

Throws:

BuildException - on error.