org.apache.tools.ant.types

Class AbstractFileSet

Implemented Interfaces:
Cloneable, SelectorContainer
Known Direct Subclasses:
DirSet, FileSet

public abstract class AbstractFileSet
extends DataType
implements Cloneable, SelectorContainer

Class that holds an implicit patternset and supports nested patternsets and creates a DirectoryScanner using these patterns.

Common base class for DirSet and FileSet.

Field Summary

Fields inherited from class org.apache.tools.ant.types.DataType

checked, description, ref

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

AbstractFileSet()
Sole constructor.
AbstractFileSet(AbstractFileSet fileset)

Method Summary

void
add(FileSelector selector)
add an arbitary 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
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
addPresent(PresentSelector selector)
add a present selector entry on the selector list
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
addType(TypeSelector selector)
add a selector type entry on the selector list
void
appendSelector(FileSelector selector)
Add a new selector into this container.
Object
clone()
Creates a deep clone of this instance, except for the nested selectors (the list of selectors is a shallow clone of this instance's list).
PatternSet.NameEntry
createExclude()
add a name entry on the exclude list
PatternSet.NameEntry
createExcludesFile()
add a name entry on the excludes files list
PatternSet.NameEntry
createInclude()
add a name entry on the include list
PatternSet.NameEntry
createIncludesFile()
add a name entry on the include files list
PatternSet
createPatternSet()
Creates a nested patternset.
protected String
getDataTypeName()
sets the name used for this datatype instance.
File
getDir(Project p)
Retrieves the base-directory for this instance.
DirectoryScanner
getDirectoryScanner(Project p)
Returns the directory scanner needed to access the files to process.
protected AbstractFileSet
getRef(Project p)
Performs the check for circular references and returns the referenced FileSet.
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
isFollowSymlinks()
find out if the fileset wants to follow symbolic links
int
selectorCount()
Gives the count of the number of selectors in this container
Enumeration
selectorElements()
Returns an enumerator for accessing the set of selectors.
void
setCaseSensitive(boolean isCaseSensitive)
Sets case sensitivity of the file system
void
setDefaultexcludes(boolean useDefaultExcludes)
Sets whether default exclusions should be used or not.
void
setDir(File dir)
Sets the base-directory for this instance.
void
setExcludes(String excludes)
Appends excludes to the current list of exclude patterns.
void
setExcludesfile(File excl)
Sets the name of 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 should be followed.
void
setIncludes(String includes)
Appends includes to the current list of include patterns.
void
setIncludesfile(File incl)
Sets the name of the file containing the includes patterns.
void
setRefid(Reference r)
Makes this instance in effect a reference to another instance.
void
setupDirectoryScanner(FileScanner ds, Project p)
String
toString()
Returns included files as a list of semicolon-separated filenames

Methods inherited from class org.apache.tools.ant.types.DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, getCheckedRef, getDescription, getRefid, isChecked, isReference, noChildrenAllowed, setChecked, setDescription, setRefid, tooManyAttributes

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Constructor Details

AbstractFileSet

public AbstractFileSet()
Sole constructor.


AbstractFileSet

protected AbstractFileSet(AbstractFileSet fileset)

Method Details

add

public void add(FileSelector selector)
add an arbitary selector
Specified by:
add in interface SelectorContainer

Parameters:
selector - the selector to add

Since:
Ant 1.6


addAnd

public void addAnd(AndSelector selector)
add an "And" selector entry on the selector list
Specified by:
addAnd in interface SelectorContainer

Parameters:
selector - the selector to add


addContains

public void addContains(ContainsSelector selector)
add a contains selector entry on the selector list
Specified by:
addContains in interface SelectorContainer

Parameters:
selector - the selector to add


addContainsRegexp

public void addContainsRegexp(ContainsRegexpSelector selector)
add a regular expression selector entry on the selector list
Specified by:
addContainsRegexp in interface SelectorContainer

Parameters:
selector - the selector to add


addCustom

public void addCustom(ExtendSelector selector)
add an extended selector entry on the selector list
Specified by:
addCustom in interface SelectorContainer

Parameters:
selector - the selector to add


addDate

public void addDate(DateSelector selector)
add a selector date entry on the selector list
Specified by:
addDate in interface SelectorContainer

Parameters:
selector - the selector to add


addDepend

public void addDepend(DependSelector selector)
add a depends selector entry on the selector list
Specified by:
addDepend in interface SelectorContainer

Parameters:
selector - the selector to add


addDepth

public void addDepth(DepthSelector selector)
add a depth selector entry on the selector list
Specified by:
addDepth in interface SelectorContainer

Parameters:
selector - the selector to add


addDifferent

public void addDifferent(DifferentSelector selector)
add a DifferentSelector entry on the selector list
Specified by:
addDifferent in interface SelectorContainer

Parameters:
selector - the selector to add


addFilename

public void addFilename(FilenameSelector selector)
add a selector filename entry on the selector list
Specified by:
addFilename in interface SelectorContainer

Parameters:
selector - the selector to add


addMajority

public void addMajority(MajoritySelector selector)
add a majority selector entry on the selector list
Specified by:
addMajority in interface SelectorContainer

Parameters:
selector - the selector to add


addModified

public void addModified(ModifiedSelector selector)
add the modified selector
Specified by:
addModified in interface SelectorContainer

Parameters:
selector - the selector to add

Since:
ant 1.6


addNone

public void addNone(NoneSelector selector)
add a "None" selector entry on the selector list
Specified by:
addNone in interface SelectorContainer

Parameters:
selector - the selector to add


addNot

public void addNot(NotSelector selector)
add a "Not" selector entry on the selector list
Specified by:
addNot in interface SelectorContainer

Parameters:
selector - the selector to add


addOr

public void addOr(OrSelector selector)
add an "Or" selector entry on the selector list
Specified by:
addOr in interface SelectorContainer

Parameters:
selector - the selector to add


addPresent

public void addPresent(PresentSelector selector)
add a present selector entry on the selector list
Specified by:
addPresent in interface SelectorContainer

Parameters:
selector - the selector to add


addSelector

public void addSelector(SelectSelector selector)
add a "Select" selector entry on the selector list
Specified by:
addSelector in interface SelectorContainer

Parameters:
selector - the selector to add


addSize

public void addSize(SizeSelector selector)
add a selector size entry on the selector list
Specified by:
addSize in interface SelectorContainer

Parameters:
selector - the selector to add


addType

public void addType(TypeSelector selector)
add a selector type entry on the selector list
Specified by:
addType in interface SelectorContainer

Parameters:
selector - the selector to add


appendSelector

public void appendSelector(FileSelector selector)
Add a new selector into this container.
Specified by:
appendSelector in interface SelectorContainer

Parameters:
selector - the new selector to add


clone

public Object clone()
Creates a deep clone of this instance, except for the nested selectors (the list of selectors is a shallow clone of this instance's list).

Since:
Ant 1.6


createExclude

public PatternSet.NameEntry createExclude()
add a name entry on the exclude list


createExcludesFile

public PatternSet.NameEntry createExcludesFile()
add a name entry on the excludes files list


createInclude

public PatternSet.NameEntry createInclude()
add a name entry on the include list


createIncludesFile

public PatternSet.NameEntry createIncludesFile()
add a name entry on the include files list


createPatternSet

public PatternSet createPatternSet()
Creates a nested patternset.


getDataTypeName

protected String getDataTypeName()
sets the name used for this datatype instance.


getDir

public File getDir(Project p)
Retrieves the base-directory for this instance.


getDirectoryScanner

public DirectoryScanner getDirectoryScanner(Project p)
Returns the directory scanner needed to access the files to process.


getRef

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


getSelectors

public FileSelector[] getSelectors(Project p)
Returns the set of selectors as an array.
Specified by:
getSelectors in interface SelectorContainer

Returns:
an array of selectors in this container


hasPatterns

public boolean hasPatterns()
Indicates whether there are any patterns here.

Returns:
whether any patterns are in this container


hasSelectors

public boolean hasSelectors()
Indicates whether there are any selectors here.
Specified by:
hasSelectors in interface SelectorContainer

Returns:
whether any selectors are in this container


isFollowSymlinks

public boolean isFollowSymlinks()
find out if the fileset wants to follow symbolic links

Returns:
flag indicating whether or not symbolic links should be followed

Since:
ant 1.6


selectorCount

public int selectorCount()
Gives the count of the number of selectors in this container
Specified by:
selectorCount in interface SelectorContainer

Returns:
the number of selectors in this container


selectorElements

public Enumeration selectorElements()
Returns an enumerator for accessing the set of selectors.
Specified by:
selectorElements in interface SelectorContainer

Returns:
an enumerator that goes through each of the selectors


setCaseSensitive

public void setCaseSensitive(boolean isCaseSensitive)
Sets case sensitivity of the file system

Parameters:
isCaseSensitive - "true"|"on"|"yes" if file system is case sensitive, "false"|"off"|"no" when not.


setDefaultexcludes

public void setDefaultexcludes(boolean useDefaultExcludes)
Sets whether default exclusions should be used or not.

Parameters:
useDefaultExcludes - "true"|"on"|"yes" when default exclusions should be used, "false"|"off"|"no" when they shouldn't be used.


setDir

public void setDir(File dir)
            throws BuildException
Sets the base-directory for this instance.


setExcludes

public void setExcludes(String excludes)
Appends excludes to the current list of exclude patterns.

Patterns may be separated by a comma or a space.

Parameters:
excludes - the string containing the exclude patterns


setExcludesfile

public void setExcludesfile(File excl)
            throws BuildException
Sets the name of the file containing the excludes patterns.

Parameters:
excl - The file to fetch the exclude patterns from.


setFile

public void setFile(File file)
Creates a single file fileset.


setFollowSymlinks

public void setFollowSymlinks(boolean followSymlinks)
Sets whether or not symbolic links should be followed.

Parameters:
followSymlinks - whether or not symbolic links should be followed


setIncludes

public void setIncludes(String includes)
Appends includes to the current list of include patterns.

Patterns may be separated by a comma or a space.

Parameters:
includes - the string containing the include patterns


setIncludesfile

public void setIncludesfile(File incl)
            throws BuildException
Sets the name of the file containing the includes patterns.

Parameters:
incl - The file to fetch the include patterns from.


setRefid

public void setRefid(Reference r)
            throws BuildException
Makes this instance in effect a reference to another instance.

You must not set another attribute or nest elements inside this element if you make it a reference.

Overrides:
setRefid in interface DataType


setupDirectoryScanner

public void setupDirectoryScanner(FileScanner ds,
                                  Project p)


toString

public String toString()
Returns included files as a list of semicolon-separated filenames

Returns:
String object with included filenames


Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.