Top Description Constructors Methods
org.apache.tools.ant.types

public Class FileSet

extends AbstractFileSet
implements ResourceCollection
Class Inheritance
All Implemented Interfaces
org.apache.tools.ant.types.ResourceCollection, java.lang.Iterable
Known Direct Subclasses
org.apache.tools.ant.types.ArchiveFileSet, org.apache.tools.ant.types.optional.depend.ClassfileSet, org.apache.tools.ant.types.resources.BCFileSet, org.apache.tools.ant.taskdefs.Javadoc.TagArgument, org.apache.tools.ant.taskdefs.optional.extension.LibFileSet
Imports
java.util.Iterator, org.apache.tools.ant.Project, org.apache.tools.ant.types.resources.FileResourceIterator
Moved out of MatchingTask to make it a standalone object that could be referenced (by scripts for example).

Constructor Summary

AccessConstructor and Description
public
FileSet()

Constructor for FileSet.

protected
FileSet(FileSet
the fileset to clone
fileset)

Constructor for FileSet, with FileSet to shallowly clone.

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

the cloned fileset
clone()

Overrides org.apache.tools.ant.types.AbstractFileSet.clone.

Return a FileSet that has the same basedir and same patternsets as this one.
protected AbstractFileSet
getRef(Project
the current project
p)

Overrides org.apache.tools.ant.types.AbstractFileSet.getRef.

Performs the check for circular references and returns the referenced FileSet.
private FileSet
getRef()

public boolean

Returns:

true indicating that all elements will be FileResources.
isFilesystemOnly()

Implements org.apache.tools.ant.types.ResourceCollection.isFilesystemOnly.

Always returns true.
public Iterator<Resource>

Returns:

an Iterator of Resources.
iterator()

Implements java.lang.Iterable.iterator.

Fulfill the ResourceCollection contract.
public int

Returns:

number of elements as int.
size()

Implements org.apache.tools.ant.types.ResourceCollection.size.

Fulfill the ResourceCollection contract.
Inherited from org.apache.tools.ant.types.AbstractFileSet:
addaddAndaddContainsaddContainsRegexpaddCustomaddDateaddDependaddDepthaddDifferentaddExecutableaddFilenameaddMajorityaddModifiedaddNoneaddNotaddOraddOwnedByaddPosixGroupaddPosixPermissionsaddPresentaddReadableaddSelectoraddSizeaddSymlinkaddTypeaddWritableappendExcludesappendIncludesappendSelectorcreateExcludecreateExcludesFilecreateIncludecreateIncludesFilecreatePatternSetdieOnCircularReferencegetDefaultexcludesgetDirgetDirgetDirectoryScannergetDirectoryScannergetErrorOnMissingDirgetMaxLevelsOfSymlinksgetSelectorshasPatternshasSelectorsisCaseSensitiveisFollowSymlinksmergeExcludesmergeIncludesmergePatternsselectorCountselectorElementssetCaseSensitivesetDefaultexcludessetDirsetErrorOnMissingDirsetExcludessetExcludesfilesetFilesetFollowSymlinkssetIncludessetIncludesfilesetMaxLevelsOfSymlinkssetRefidsetupDirectoryScannersetupDirectoryScannertoString

Constructor Detail

FileSetback to summary
public FileSet()

Constructor for FileSet.

FileSetback to summary
protected FileSet(FileSet fileset)

Constructor for FileSet, with FileSet to shallowly clone.

Parameters
fileset:FileSet

the fileset to clone

Method Detail

cloneback to summary
public Object clone()

Overrides org.apache.tools.ant.types.AbstractFileSet.clone.

Return a FileSet that has the same basedir and same patternsets as this one.

Returns:Object

the cloned fileset

Annotations
@Override
getRefback to summary
protected AbstractFileSet getRef(Project p)

Overrides org.apache.tools.ant.types.AbstractFileSet.getRef.

Doc from org.apache.tools.ant.types.AbstractFileSet.getRef.

Performs the check for circular references and returns the referenced FileSet. This method can be overridden together with getRef() providing implementations containing the special support for FileSet references, which can be handled by all ArchiveFileSets. NB! This method must be overridden in subclasses such as FileSet and DirSet to distinguish between the data types.

Parameters
p:Project

the current project

Returns:AbstractFileSet

the dereferenced object.

Annotations
@Override
getRefback to summary
private FileSet getRef()
isFilesystemOnlyback to summary
public boolean isFilesystemOnly()

Implements org.apache.tools.ant.types.ResourceCollection.isFilesystemOnly.

Always returns true.

Returns:boolean

true indicating that all elements will be FileResources.

Annotations
@Override
Since
Ant 1.7
iteratorback to summary
public Iterator<Resource> iterator()

Implements java.lang.Iterable.iterator.

Fulfill the ResourceCollection contract.

Returns:Iterator<Resource>

an Iterator of Resources.

Annotations
@Override
Since
Ant 1.7
sizeback to summary
public int size()

Implements org.apache.tools.ant.types.ResourceCollection.size.

Fulfill the ResourceCollection contract.

Returns:int

number of elements as int.

Annotations
@Override
Since
Ant 1.7