|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.AbstractFileSet
public abstract class AbstractFileSet
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, ref |
| Fields inherited from class org.apache.tools.ant.ProjectComponent |
|---|
description, location, project |
| Constructor Summary | |
|---|---|
|
AbstractFileSet()
Construct a new AbstractFileSet. |
protected |
AbstractFileSet(AbstractFileSet fileset)
Construct a new AbstractFileSet, shallowly cloned
from the specified AbstractFileSet. |
| 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 |
appendExcludes(java.lang.String[] excludes)
Appends excludes to the current list of include
patterns. |
void |
appendIncludes(java.lang.String[] includes)
Appends includes to the current list of include
patterns. |
void |
appendSelector(FileSelector selector)
Add a new selector into this container. |
java.lang.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 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. |
java.io.File |
getDir()
Retrieves the base-directory for this instance. |
java.io.File |
getDir(Project p)
Retrieves the base-directory for this instance. |
DirectoryScanner |
getDirectoryScanner()
Returns the directory scanner needed to access the files to process. |
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 |
isCaseSensitive()
Find out if the fileset is case sensitive. |
boolean |
isFollowSymlinks()
Find out if the fileset wants to follow symbolic links. |
java.lang.String[] |
mergeExcludes(Project p)
Get the merged exclude patterns for this AbstractFileSet. |
java.lang.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. |
java.util.Enumeration |
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 |
setDir(java.io.File dir)
Sets the base-directory for this instance. |
void |
setErrorOnMissingDir(boolean errorOnMissingDir)
Sets whether an error is thrown if a directory does not exist. |
void |
setExcludes(java.lang.String excludes)
Appends excludes to the current list of exclude
patterns. |
void |
setExcludesfile(java.io.File excl)
Sets the File containing the excludes patterns. |
void |
setFile(java.io.File file)
Creates a single file fileset. |
void |
setFollowSymlinks(boolean followSymlinks)
Sets whether or not symbolic links should be followed. |
void |
setIncludes(java.lang.String includes)
Appends includes to the current list of include
patterns. |
void |
setIncludesfile(java.io.File incl)
Sets the File containing the includes patterns. |
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. |
java.lang.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, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, setChecked, tooManyAttributes |
| Methods inherited from class org.apache.tools.ant.ProjectComponent |
|---|
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public AbstractFileSet()
AbstractFileSet.
protected AbstractFileSet(AbstractFileSet fileset)
AbstractFileSet, shallowly cloned
from the specified AbstractFileSet.
fileset - the AbstractFileSet to use as a template.| Method Detail |
|---|
public void setRefid(Reference r)
throws BuildException
You must not set another attribute or nest elements inside this element if you make it a reference.
setRefid in class DataTyper - the Reference to use.
BuildException - on error
public void setDir(java.io.File dir)
throws BuildException
dir - the directory's File instance.
BuildException - on errorpublic java.io.File getDir()
File.public java.io.File getDir(Project p)
p - the Project against which the
reference is resolved, if set.
File.public PatternSet createPatternSet()
PatternSet.public PatternSet.NameEntry createInclude()
PatternSet.NameEntry.public PatternSet.NameEntry createIncludesFile()
PatternSet.NameEntry.public PatternSet.NameEntry createExclude()
PatternSet.NameEntry.public PatternSet.NameEntry createExcludesFile()
PatternSet.NameEntry.public void setFile(java.io.File file)
file - the single File included in this
AbstractFileSet.public void setIncludes(java.lang.String includes)
includes to the current list of include
patterns.
Patterns may be separated by a comma or a space.
includes - the String containing the include patterns.public void appendIncludes(java.lang.String[] includes)
includes to the current list of include
patterns.
includes - array containing the include patterns.public void setExcludes(java.lang.String excludes)
excludes to the current list of exclude
patterns.
Patterns may be separated by a comma or a space.
excludes - the String containing the exclude patterns.public void appendExcludes(java.lang.String[] excludes)
excludes to the current list of include
patterns.
excludes - array containing the exclude patterns.
public void setIncludesfile(java.io.File incl)
throws BuildException
File containing the includes patterns.
incl - File instance.
BuildException - on error
public void setExcludesfile(java.io.File excl)
throws BuildException
File containing the excludes patterns.
excl - File instance.
BuildException - on errorpublic void setDefaultexcludes(boolean useDefaultExcludes)
useDefaultExcludes - boolean.public boolean getDefaultexcludes()
public void setCaseSensitive(boolean caseSensitive)
caseSensitive - boolean.public boolean isCaseSensitive()
boolean indicating whether the fileset is
case sensitive.public void setFollowSymlinks(boolean followSymlinks)
followSymlinks - whether or not symbolic links should be followed.public boolean isFollowSymlinks()
boolean indicating whether symbolic links
should be followed.public void setErrorOnMissingDir(boolean errorOnMissingDir)
errorOnMissingDir - true if missing directories cause errors,
false if not.public DirectoryScanner getDirectoryScanner()
DirectoryScanner instance.public DirectoryScanner getDirectoryScanner(Project p)
p - the Project against which the DirectoryScanner should be configured.
DirectoryScanner instance.public void setupDirectoryScanner(FileScanner ds)
ds - a FileScanner instance.
public void setupDirectoryScanner(FileScanner ds,
Project p)
ds - a FileScanner instance.p - an Ant Project instance.protected AbstractFileSet getRef(Project p)
p - the current project
public boolean hasSelectors()
hasSelectors in interface SelectorContainerpublic boolean hasPatterns()
public int selectorCount()
selectorCount in interface SelectorContainerint.public FileSelector[] getSelectors(Project p)
getSelectors in interface SelectorContainerp - the current project
FileSelector[] of the selectors in this container.public java.util.Enumeration selectorElements()
selectorElements in interface SelectorContainerEnumeration of selectors.public void appendSelector(FileSelector selector)
appendSelector in interface SelectorContainerselector - the new FileSelector to add.public void addSelector(SelectSelector selector)
addSelector in interface SelectorContainerselector - the SelectSelector to add.public void addAnd(AndSelector selector)
addAnd in interface SelectorContainerselector - the AndSelector to add.public void addOr(OrSelector selector)
addOr in interface SelectorContainerselector - the OrSelector to add.public void addNot(NotSelector selector)
addNot in interface SelectorContainerselector - the NotSelector to add.public void addNone(NoneSelector selector)
addNone in interface SelectorContainerselector - the NoneSelector to add.public void addMajority(MajoritySelector selector)
addMajority in interface SelectorContainerselector - the MajoritySelector to add.public void addDate(DateSelector selector)
addDate in interface SelectorContainerselector - the DateSelector to add.public void addSize(SizeSelector selector)
addSize in interface SelectorContainerselector - the SizeSelector to add.public void addDifferent(DifferentSelector selector)
addDifferent in interface SelectorContainerselector - the DifferentSelector to add.public void addFilename(FilenameSelector selector)
addFilename in interface SelectorContainerselector - the FilenameSelector to add.public void addType(TypeSelector selector)
addType in interface SelectorContainerselector - the TypeSelector to add.public void addCustom(ExtendSelector selector)
addCustom in interface SelectorContainerselector - the ExtendSelector to add.public void addContains(ContainsSelector selector)
addContains in interface SelectorContainerselector - the ContainsSelector to add.public void addPresent(PresentSelector selector)
addPresent in interface SelectorContainerselector - the PresentSelector to add.public void addDepth(DepthSelector selector)
addDepth in interface SelectorContainerselector - the DepthSelector to add.public void addDepend(DependSelector selector)
addDepend in interface SelectorContainerselector - the DependSelector to add.public void addContainsRegexp(ContainsRegexpSelector selector)
addContainsRegexp in interface SelectorContainerselector - the ContainsRegexpSelector to add.public void addModified(ModifiedSelector selector)
addModified in interface SelectorContainerselector - the ModifiedSelector to add.public void add(FileSelector selector)
add in interface SelectorContainerselector - the FileSelector to add.public java.lang.String toString()
toString in class DataTypeString of included filenames.public java.lang.Object clone()
clone in class DataTypepublic java.lang.String[] mergeIncludes(Project p)
p - the project to use.
public java.lang.String[] mergeExcludes(Project p)
p - the project to use.
public PatternSet mergePatterns(Project p)
p - the project to use.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||