Apache Ant Core 1.10.14 · org.apache.tools.ant.types.resources.Files

Modifier and Type	Field and Description
private Vector<PatternSet>	additionalPatterns
private boolean	caseSensitive
private PatternSet	defaultPatterns
private DirectoryScanner	ds
private boolean	followSymlinks
private boolean	useDefaultExcludes

Access	Constructor and Description
public	Files() Construct a new `Files` collection.
protected	Files(Files the `Files` to use as a template. f) Construct a new `Files` collection, shallowly cloned from the specified `Files`.

Method Summary

Modifier and Type	Method and Description
public synchronized void	appendExcludes(String[] array containing the exclude patterns. excludes) Append `excludes` to the current list of include patterns.
public synchronized void	appendIncludes(String[] array containing the include patterns. includes) Append `includes` to the current list of include patterns.
public synchronized void	appendSelector(FileSelector the new `FileSelector` to add. selector) Overrides org.apache.tools.ant.types.selectors.AbstractSelectorContainer.appendSelector. Implements org.apache.tools.ant.types.selectors.SelectorContainer.appendSelector. Add a new selector into this container.
public synchronized Object	Returns: a cloned Object. clone() Overrides org.apache.tools.ant.types.selectors.AbstractSelectorContainer.clone. Create a deep clone of this instance, except for the nested selectors (the list of selectors is a shallow clone of this instance's list).
public synchronized PatternSet.NameEntry	Returns: `PatternSet.NameEntry`. createExclude() Add a name entry to the exclude list.
public synchronized PatternSet.NameEntry	Returns: `PatternSet.PatternFileNameEntry`. createExcludesFile() Add a name entry to the excludes files list.
public synchronized PatternSet.NameEntry	Returns: `PatternSet.NameEntry`. createInclude() Add a name entry to the include list.
public synchronized PatternSet.NameEntry	Returns: `PatternSet.PatternFileNameEntry`. createIncludesFile() Add a name entry to the include files list.
public synchronized PatternSet	Returns: `PatternSet`. createPatternSet() Create a nested patternset.
private synchronized void	ensureDirectoryScannerSetup()
public synchronized boolean	Returns: the defaultexclusions value. getDefaultexcludes() Get whether default exclusions should be used or not.
protected Files	Returns: `FileCollection`. getRef() Hides org.apache.tools.ant.types.selectors.AbstractSelectorContainer.getRef. Perform the check for circular references and return the referenced Files collection.
public synchronized boolean	Returns: whether any patterns are in this container. hasPatterns() Find out whether this Files collection has patterns.
private boolean	hasPatterns(PatternSet ps)
public synchronized boolean	Returns: `boolean` indicating whether the Files collection is case-sensitive. isCaseSensitive() Find out if this Files collection is case-sensitive.
public boolean	Returns: true indicating that all elements of a Files collection will be FileResources. isFilesystemOnly() Implements org.apache.tools.ant.types.ResourceCollection.isFilesystemOnly. Always returns true.
public synchronized boolean	Returns: `boolean` indicating whether symbolic links should be followed. isFollowSymlinks() Find out whether symbolic links should be followed.
public synchronized Iterator<Resource>	Returns: an Iterator of Resources. iterator() Implements java.lang.Iterable.iterator. Fulfill the ResourceCollection contract.
public String[]	Returns: the exclude patterns of the default pattern set and all nested patternsets. mergeExcludes(Project Project instance. p) Get the merged exclude patterns for this Files collection.
public String[]	Returns: the include patterns of the default pattern set and all nested patternsets. mergeIncludes(Project Project instance. p) Get the merged include patterns for this Files collection.
public synchronized PatternSet	Returns: the default patternset merged with the additional sets in a new PatternSet instance. mergePatterns(Project Project instance. p) Get the merged patterns for this Files collection.
public synchronized void	setCaseSensitive(boolean `boolean`. caseSensitive) Set case-sensitivity of the Files collection.
public synchronized void	setDefaultexcludes(boolean `boolean`. useDefaultExcludes) Set whether default exclusions should be used or not.
public synchronized void	setExcludes(String the `String` containing the exclude patterns. excludes) Append `excludes` to the current list of exclude patterns.
public synchronized void	setExcludesfile(File `File` instance. excl) Set the `File` containing the excludes patterns.
public synchronized void	setFollowSymlinks(boolean whether or not symbolic links should be followed. followSymlinks) Set whether or not symbolic links should be followed.
public synchronized void	setIncludes(String the `String` containing the include patterns. includes) Append `includes` to the current list of include patterns.
public synchronized void	setIncludesfile(File `File` instance. incl) Set the `File` containing the includes patterns.
public void	setRefid(Reference the `Reference` to use. r) Overrides org.apache.tools.ant.types.DataType.setRefid. Make this instance in effect a reference to another instance.
public synchronized int	Returns: number of elements as int. size() Implements org.apache.tools.ant.types.ResourceCollection.size. Fulfill the ResourceCollection contract.
public String	Returns: a descriptive `String`. toString() Overrides org.apache.tools.ant.types.selectors.AbstractSelectorContainer.toString. Format this Files collection as a String.

additionalPatterns	back to summary
private Vector<PatternSet> additionalPatterns

caseSensitive	back to summary
private boolean caseSensitive

defaultPatterns	back to summary
private PatternSet defaultPatterns

ds	back to summary
private DirectoryScanner ds

followSymlinks	back to summary
private boolean followSymlinks

useDefaultExcludes	back to summary
private boolean useDefaultExcludes

Files	back to summary
public Files() Construct a new `Files` collection.

Files	back to summary
protected Files(Files f) Construct a new `Files` collection, shallowly cloned from the specified `Files`. Parameters f:Files the `Files` to use as a template.

Method Detail

appendExcludes back to summary

appendExcludes	back to summary
public synchronized void appendExcludes(String[] excludes) Append `excludes` to the current list of include patterns. Parameters excludes:String[] array containing the exclude patterns.

public synchronized void appendExcludes(String[] excludes)

Append excludes to the current list of include patterns.

Parameters

excludes:String[]: array containing the exclude patterns.

appendIncludes back to summary

appendIncludes	back to summary
public synchronized void appendIncludes(String[] includes) Append `includes` to the current list of include patterns. Parameters includes:String[] array containing the include patterns.

public synchronized void appendIncludes(String[] includes)

Append includes to the current list of include patterns.

Parameters

includes:String[]: array containing the include patterns.

appendSelector back to summary

appendSelector	back to summary
public synchronized void appendSelector(FileSelector selector) Overrides org.apache.tools.ant.types.selectors.AbstractSelectorContainer.appendSelector. Implements org.apache.tools.ant.types.selectors.SelectorContainer.appendSelector. Add a new selector into this container. Parameters selector:FileSelector the new `FileSelector` to add. Annotations @Override

public synchronized void appendSelector(FileSelector selector)

Overrides org.apache.tools.ant.types.selectors.AbstractSelectorContainer.appendSelector.

Implements org.apache.tools.ant.types.selectors.SelectorContainer.appendSelector.

Add a new selector into this container.

Parameters

selector:FileSelector: the new FileSelector to add.

Annotations

@Override

clone	back to summary
public synchronized Object clone() Overrides org.apache.tools.ant.types.selectors.AbstractSelectorContainer.clone. Create a deep clone of this instance, except for the nested selectors (the list of selectors is a shallow clone of this instance's list). Returns:Object a cloned Object. Annotations @Override

clone

back to summary

public synchronized Object clone()

Overrides org.apache.tools.ant.types.selectors.AbstractSelectorContainer.clone.

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

Returns:Object

a cloned Object.

Annotations

@Override

createExclude back to summary

createExclude	back to summary
public synchronized PatternSet.NameEntry createExclude() Add a name entry to the exclude list. Returns:PatternSet.NameEntry `PatternSet.NameEntry`.

public synchronized PatternSet.NameEntry createExclude()

Add a name entry to the exclude list.

Returns:PatternSet.NameEntry: PatternSet.NameEntry.

createExcludesFile back to summary

createExcludesFile	back to summary
public synchronized PatternSet.NameEntry createExcludesFile() Add a name entry to the excludes files list. Returns:PatternSet.NameEntry `PatternSet.PatternFileNameEntry`.

public synchronized PatternSet.NameEntry createExcludesFile()

Add a name entry to the excludes files list.

Returns:PatternSet.NameEntry: PatternSet.PatternFileNameEntry.

createInclude back to summary

createInclude	back to summary
public synchronized PatternSet.NameEntry createInclude() Add a name entry to the include list. Returns:PatternSet.NameEntry `PatternSet.NameEntry`.

public synchronized PatternSet.NameEntry createInclude()

Add a name entry to the include list.

Returns:PatternSet.NameEntry: PatternSet.NameEntry.

createIncludesFile back to summary

createIncludesFile	back to summary
public synchronized PatternSet.NameEntry createIncludesFile() Add a name entry to the include files list. Returns:PatternSet.NameEntry `PatternSet.PatternFileNameEntry`.

public synchronized PatternSet.NameEntry createIncludesFile()

Add a name entry to the include files list.

Returns:PatternSet.NameEntry: PatternSet.PatternFileNameEntry.

createPatternSet back to summary

createPatternSet	back to summary
public synchronized PatternSet createPatternSet() Create a nested patternset. Returns:PatternSet `PatternSet`.

public synchronized PatternSet createPatternSet()

Create a nested patternset.

Returns:PatternSet: PatternSet.

ensureDirectoryScannerSetup	back to summary
private synchronized void ensureDirectoryScannerSetup()

getDefaultexcludes	back to summary
public synchronized boolean getDefaultexcludes() Get whether default exclusions should be used or not. Returns:boolean the defaultexclusions value.

getDefaultexcludes

back to summary

public synchronized boolean getDefaultexcludes()

Get whether default exclusions should be used or not.

Returns:boolean: the defaultexclusions value.

getRef back to summary

getRef	back to summary
protected Files getRef() Hides org.apache.tools.ant.types.selectors.AbstractSelectorContainer.getRef. Perform the check for circular references and return the referenced Files collection. Returns:Files `FileCollection`.

protected Files getRef()

Hides org.apache.tools.ant.types.selectors.AbstractSelectorContainer.getRef.

Perform the check for circular references and return the referenced Files collection.

Returns:Files: FileCollection.

hasPatterns	back to summary
public synchronized boolean hasPatterns() Find out whether this Files collection has patterns. Returns:boolean whether any patterns are in this container.

hasPatterns

back to summary

public synchronized boolean hasPatterns()

Find out whether this Files collection has patterns.

Returns:boolean: whether any patterns are in this container.

hasPatterns	back to summary
private boolean hasPatterns(PatternSet ps)

isCaseSensitive back to summary

isCaseSensitive	back to summary
public synchronized boolean isCaseSensitive() Find out if this Files collection is case-sensitive. Returns:boolean `boolean` indicating whether the Files collection is case-sensitive.

public synchronized boolean isCaseSensitive()

Find out if this Files collection is case-sensitive.

Returns:boolean: boolean indicating whether the Files collection is case-sensitive.

isFilesystemOnly	back to summary
public boolean isFilesystemOnly() Implements org.apache.tools.ant.types.ResourceCollection.isFilesystemOnly. Always returns true. Returns:boolean true indicating that all elements of a Files collection will be FileResources. Annotations @Override

isFilesystemOnly

back to summary

public boolean isFilesystemOnly()

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

Always returns true.

Returns:boolean

true indicating that all elements of a Files collection will be FileResources.

Annotations

@Override

isFollowSymlinks back to summary

isFollowSymlinks	back to summary
public synchronized boolean isFollowSymlinks() Find out whether symbolic links should be followed. Returns:boolean `boolean` indicating whether symbolic links should be followed.

public synchronized boolean isFollowSymlinks()

Find out whether symbolic links should be followed.

Returns:boolean: boolean indicating whether symbolic links should be followed.

iterator	back to summary
public synchronized Iterator<Resource> iterator() Implements java.lang.Iterable.iterator. Fulfill the ResourceCollection contract. Returns:Iterator<Resource> an Iterator of Resources. Annotations @Override

iterator

back to summary

public synchronized Iterator<Resource> iterator()

Implements java.lang.Iterable.iterator.

Fulfill the ResourceCollection contract.

Returns:Iterator<Resource>

an Iterator of Resources.

Annotations

@Override

mergeExcludes	back to summary
public String[] mergeExcludes(Project p) Get the merged exclude patterns for this Files collection. Parameters p:Project Project instance. Returns:String[] the exclude patterns of the default pattern set and all nested patternsets.

mergeExcludes

back to summary

public String[] mergeExcludes(Project p)

Get the merged exclude patterns for this Files collection.

Parameters

p:Project: Project instance.

Returns:String[]

the exclude patterns of the default pattern set and all nested patternsets.

mergeIncludes	back to summary
public String[] mergeIncludes(Project p) Get the merged include patterns for this Files collection. Parameters p:Project Project instance. Returns:String[] the include patterns of the default pattern set and all nested patternsets.

mergeIncludes

back to summary

public String[] mergeIncludes(Project p)

Get the merged include patterns for this Files collection.

Parameters

p:Project: Project instance.

Returns:String[]

the include patterns of the default pattern set and all nested patternsets.

mergePatterns	back to summary
public synchronized PatternSet mergePatterns(Project p) Get the merged patterns for this Files collection. Parameters p:Project Project instance. Returns:PatternSet the default patternset merged with the additional sets in a new PatternSet instance.

mergePatterns

back to summary

public synchronized PatternSet mergePatterns(Project p)

Get the merged patterns for this Files collection.

Parameters

p:Project: Project instance.

Returns:PatternSet

the default patternset merged with the additional sets in a new PatternSet instance.

setCaseSensitive back to summary

setCaseSensitive	back to summary
public synchronized void setCaseSensitive(boolean caseSensitive) Set case-sensitivity of the Files collection. Parameters caseSensitive:boolean `boolean`.

public synchronized void setCaseSensitive(boolean caseSensitive)

Set case-sensitivity of the Files collection.

Parameters

caseSensitive:boolean: boolean.

setDefaultexcludes back to summary

setDefaultexcludes	back to summary
public synchronized void setDefaultexcludes(boolean useDefaultExcludes) Set whether default exclusions should be used or not. Parameters useDefaultExcludes:boolean `boolean`.

public synchronized void setDefaultexcludes(boolean useDefaultExcludes)

Set whether default exclusions should be used or not.

Parameters

useDefaultExcludes:boolean: boolean.

setExcludes back to summary

setExcludes	back to summary
public synchronized void setExcludes(String excludes) Append `excludes` to the current list of exclude patterns. Patterns may be separated by a comma or a space. Parameters excludes:String the `String` containing the exclude patterns.

public synchronized void setExcludes(String excludes)

Append excludes to the current list of exclude patterns.

Patterns may be separated by a comma or a space.

Parameters

excludes:String: the String containing the exclude patterns.

setExcludesfile back to summary

setExcludesfile	back to summary
public synchronized void setExcludesfile(File excl) throws BuildException Set the `File` containing the excludes patterns. Parameters excl:File `File` instance. Exceptions BuildException: if there is a problem.

public synchronized void setExcludesfile(File excl) throws BuildException

Set the File containing the excludes patterns.

Parameters

excl:File: File instance.

Exceptions

BuildException:: if there is a problem.

setFollowSymlinks	back to summary
public synchronized void setFollowSymlinks(boolean followSymlinks) Set whether or not symbolic links should be followed. Parameters followSymlinks:boolean whether or not symbolic links should be followed.

setFollowSymlinks

back to summary

public synchronized void setFollowSymlinks(boolean followSymlinks)

Set whether or not symbolic links should be followed.

Parameters

followSymlinks:boolean: whether or not symbolic links should be followed.

setIncludes back to summary

setIncludes	back to summary
public synchronized void setIncludes(String includes) Append `includes` to the current list of include patterns. Patterns may be separated by a comma or a space. Parameters includes:String the `String` containing the include patterns.

public synchronized void setIncludes(String includes)

Append includes to the current list of include patterns.

Patterns may be separated by a comma or a space.

Parameters

includes:String: the String containing the include patterns.

setIncludesfile back to summary

setIncludesfile	back to summary
public synchronized void setIncludesfile(File incl) throws BuildException Set the `File` containing the includes patterns. Parameters incl:File `File` instance. Exceptions BuildException: if there is a problem.

public synchronized void setIncludesfile(File incl) throws BuildException

Set the File containing the includes patterns.

Parameters

incl:File: File instance.

Exceptions

BuildException:: if there is a problem.

setRefid back to summary

setRefid	back to summary
public void setRefid(Reference r) throws BuildException Overrides org.apache.tools.ant.types.DataType.setRefid. Make 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. Parameters r:Reference the `Reference` to use. Annotations @Override Exceptions BuildException: if there is a problem.

public void setRefid(Reference r) throws BuildException

Overrides org.apache.tools.ant.types.DataType.setRefid.

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

Parameters

r:Reference: the Reference to use.

Annotations

@Override

Exceptions

BuildException:: if there is a problem.

size	back to summary
public synchronized int size() Implements org.apache.tools.ant.types.ResourceCollection.size. Fulfill the ResourceCollection contract. Returns:int number of elements as int. Annotations @Override

size

back to summary

public synchronized int size()

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

Fulfill the ResourceCollection contract.

Returns:int

number of elements as int.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides org.apache.tools.ant.types.selectors.AbstractSelectorContainer.toString. Format this Files collection as a String. Returns:String a descriptive `String`. Annotations @Override

public String toString()

Overrides org.apache.tools.ant.types.selectors.AbstractSelectorContainer.toString.

Format this Files collection as a String.

Returns:String

a descriptive String.

Annotations

@Override

public Class Files

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail