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

public Class DirSet

extends AbstractFileSet
implements ResourceCollection
Class Inheritance
All Implemented Interfaces
org.apache.tools.ant.types.ResourceCollection, java.lang.Iterable
Imports
java.util.Iterator, org.apache.tools.ant.Project, org.apache.tools.ant.types.resources.FileResourceIterator
Subclass as hint for supporting tasks that the included directories instead of files should be used.
Since
Ant 1.5

Constructor Summary

AccessConstructor and Description
public
DirSet()

Constructor for DirSet.

protected
DirSet(DirSet
the dirset to clone.
dirset)

Constructor for DirSet, with DirSet to shallowly clone.

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

the cloned dirset.
clone()

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

Return a DirSet 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 DirSet
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.
public String

Returns:

a String of included directories.
toString()

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

Returns included directories as a list of semicolon-separated paths.
Inherited from org.apache.tools.ant.types.AbstractFileSet:
addaddAndaddContainsaddContainsRegexpaddCustomaddDateaddDependaddDepthaddDifferentaddExecutableaddFilenameaddMajorityaddModifiedaddNoneaddNotaddOraddOwnedByaddPosixGroupaddPosixPermissionsaddPresentaddReadableaddSelectoraddSizeaddSymlinkaddTypeaddWritableappendExcludesappendIncludesappendSelectorcreateExcludecreateExcludesFilecreateIncludecreateIncludesFilecreatePatternSetdieOnCircularReferencegetDefaultexcludesgetDirgetDirgetDirectoryScannergetDirectoryScannergetErrorOnMissingDirgetMaxLevelsOfSymlinksgetSelectorshasPatternshasSelectorsisCaseSensitiveisFollowSymlinksmergeExcludesmergeIncludesmergePatternsselectorCountselectorElementssetCaseSensitivesetDefaultexcludessetDirsetErrorOnMissingDirsetExcludessetExcludesfilesetFilesetFollowSymlinkssetIncludessetIncludesfilesetMaxLevelsOfSymlinkssetRefidsetupDirectoryScannersetupDirectoryScanner

Constructor Detail

DirSetback to summary
public DirSet()

Constructor for DirSet.

DirSetback to summary
protected DirSet(DirSet dirset)

Constructor for DirSet, with DirSet to shallowly clone.

Parameters
dirset:DirSet

the dirset to clone.

Method Detail

cloneback to summary
public Object clone()

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

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

Returns:Object

the cloned dirset.

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 DirSet 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
toStringback to summary
public String toString()

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

Returns included directories as a list of semicolon-separated paths.

Returns:String

a String of included directories.

Annotations
@Override