Class Files
- java.lang.Object
- 
- org.apache.tools.ant.ProjectComponent
- 
- org.apache.tools.ant.types.DataType
- 
- org.apache.tools.ant.types.selectors.AbstractSelectorContainer
- 
- org.apache.tools.ant.types.resources.Files
 
 
 
 
- 
- All Implemented Interfaces:
- java.lang.Cloneable,- java.lang.Iterable<Resource>,- ResourceCollection,- SelectorContainer
 
 public class Files extends AbstractSelectorContainer implements ResourceCollection ResourceCollection implementation; like AbstractFileSet with absolute paths.- Since:
- Ant 1.7
 
- 
- 
Field Summary- 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Method SummaryModifier and Type Method Description voidappendExcludes(java.lang.String[] excludes)Appendexcludesto the current list of include patterns.voidappendIncludes(java.lang.String[] includes)Appendincludesto the current list of include patterns.voidappendSelector(FileSelector selector)Add a new selector into this container.java.lang.Objectclone()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).PatternSet.NameEntrycreateExclude()Add a name entry to the exclude list.PatternSet.NameEntrycreateExcludesFile()Add a name entry to the excludes files list.PatternSet.NameEntrycreateInclude()Add a name entry to the include list.PatternSet.NameEntrycreateIncludesFile()Add a name entry to the include files list.PatternSetcreatePatternSet()Create a nested patternset.booleangetDefaultexcludes()Get whether default exclusions should be used or not.protected FilesgetRef()Perform the check for circular references and return the referenced Files collection.booleanhasPatterns()Find out whether this Files collection has patterns.booleanisCaseSensitive()Find out if this Files collection is case-sensitive.booleanisFilesystemOnly()Always returns true.booleanisFollowSymlinks()Find out whether symbolic links should be followed.java.util.Iterator<Resource>iterator()Fulfill the ResourceCollection contract.java.lang.String[]mergeExcludes(Project p)Get the merged exclude patterns for this Files collection.java.lang.String[]mergeIncludes(Project p)Get the merged include patterns for this Files collection.PatternSetmergePatterns(Project p)Get the merged patterns for this Files collection.voidsetCaseSensitive(boolean caseSensitive)Set case-sensitivity of the Files collection.voidsetDefaultexcludes(boolean useDefaultExcludes)Set whether default exclusions should be used or not.voidsetExcludes(java.lang.String excludes)Appendexcludesto the current list of exclude patterns.voidsetExcludesfile(java.io.File excl)Set theFilecontaining the excludes patterns.voidsetFollowSymlinks(boolean followSymlinks)Set whether or not symbolic links should be followed.voidsetIncludes(java.lang.String includes)Appendincludesto the current list of include patterns.voidsetIncludesfile(java.io.File incl)Set theFilecontaining the includes patterns.voidsetRefid(Reference r)Make this instance in effect a reference to another instance.intsize()Fulfill the ResourceCollection contract.java.lang.StringtoString()Format this Files collection as a String.- 
Methods inherited from class org.apache.tools.ant.types.selectors.AbstractSelectorContaineradd, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addExecutable, addFilename, addMajority, addModified, addNone, addNot, addOr, addOwnedBy, addPosixGroup, addPosixPermissions, addPresent, addReadable, addSelector, addSize, addSymlink, addType, addWritable, dieOnCircularReference, getSelectors, hasSelectors, selectorCount, selectorElements, validate
 - 
Methods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
 - 
Methods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
 - 
Methods inherited from class java.lang.Objectequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface org.apache.tools.ant.types.ResourceCollectionisEmpty, stream
 
- 
 
- 
- 
- 
Constructor Detail- 
Filespublic Files() Construct a newFilescollection.
 - 
Filesprotected Files(Files f) Construct a newFilescollection, shallowly cloned from the specifiedFiles.- Parameters:
- f- the- Filesto use as a template.
 
 
- 
 - 
Method Detail- 
setRefidpublic void setRefid(Reference r) throws BuildException 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. - Overrides:
- setRefidin class- DataType
- Parameters:
- r- the- Referenceto use.
- Throws:
- BuildException- if there is a problem.
 
 - 
createPatternSetpublic PatternSet createPatternSet() Create a nested patternset.- Returns:
- PatternSet.
 
 - 
createIncludepublic PatternSet.NameEntry createInclude() Add a name entry to the include list.- Returns:
- PatternSet.NameEntry.
 
 - 
createIncludesFilepublic PatternSet.NameEntry createIncludesFile() Add a name entry to the include files list.- Returns:
- PatternSet.PatternFileNameEntry.
 
 - 
createExcludepublic PatternSet.NameEntry createExclude() Add a name entry to the exclude list.- Returns:
- PatternSet.NameEntry.
 
 - 
createExcludesFilepublic PatternSet.NameEntry createExcludesFile() Add a name entry to the excludes files list.- Returns:
- PatternSet.PatternFileNameEntry.
 
 - 
setIncludespublic void setIncludes(java.lang.String includes) Appendincludesto the current list of include patterns.Patterns may be separated by a comma or a space. - Parameters:
- includes- the- Stringcontaining the include patterns.
 
 - 
appendIncludespublic void appendIncludes(java.lang.String[] includes) Appendincludesto the current list of include patterns.- Parameters:
- includes- array containing the include patterns.
 
 - 
setExcludespublic void setExcludes(java.lang.String excludes) Appendexcludesto the current list of exclude patterns.Patterns may be separated by a comma or a space. - Parameters:
- excludes- the- Stringcontaining the exclude patterns.
 
 - 
appendExcludespublic void appendExcludes(java.lang.String[] excludes) Appendexcludesto the current list of include patterns.- Parameters:
- excludes- array containing the exclude patterns.
 
 - 
setIncludesfilepublic void setIncludesfile(java.io.File incl) throws BuildExceptionSet theFilecontaining the includes patterns.- Parameters:
- incl-- Fileinstance.
- Throws:
- BuildException- if there is a problem.
 
 - 
setExcludesfilepublic void setExcludesfile(java.io.File excl) throws BuildExceptionSet theFilecontaining the excludes patterns.- Parameters:
- excl-- Fileinstance.
- Throws:
- BuildException- if there is a problem.
 
 - 
setDefaultexcludespublic void setDefaultexcludes(boolean useDefaultExcludes) Set whether default exclusions should be used or not.- Parameters:
- useDefaultExcludes-- boolean.
 
 - 
getDefaultexcludespublic boolean getDefaultexcludes() Get whether default exclusions should be used or not.- Returns:
- the defaultexclusions value.
 
 - 
setCaseSensitivepublic void setCaseSensitive(boolean caseSensitive) Set case-sensitivity of the Files collection.- Parameters:
- caseSensitive-- boolean.
 
 - 
isCaseSensitivepublic boolean isCaseSensitive() Find out if this Files collection is case-sensitive.- Returns:
- booleanindicating whether the Files collection is case-sensitive.
 
 - 
setFollowSymlinkspublic void setFollowSymlinks(boolean followSymlinks) Set whether or not symbolic links should be followed.- Parameters:
- followSymlinks- whether or not symbolic links should be followed.
 
 - 
isFollowSymlinkspublic boolean isFollowSymlinks() Find out whether symbolic links should be followed.- Returns:
- booleanindicating whether symbolic links should be followed.
 
 - 
iteratorpublic java.util.Iterator<Resource> iterator() Fulfill the ResourceCollection contract.- Specified by:
- iteratorin interface- java.lang.Iterable<Resource>
- Returns:
- an Iterator of Resources.
 
 - 
sizepublic int size() Fulfill the ResourceCollection contract.- Specified by:
- sizein interface- ResourceCollection
- Returns:
- number of elements as int.
 
 - 
hasPatternspublic boolean hasPatterns() Find out whether this Files collection has patterns.- Returns:
- whether any patterns are in this container.
 
 - 
appendSelectorpublic void appendSelector(FileSelector selector) Add a new selector into this container.- Specified by:
- appendSelectorin interface- SelectorContainer
- Overrides:
- appendSelectorin class- AbstractSelectorContainer
- Parameters:
- selector- the new- FileSelectorto add.
 
 - 
toStringpublic java.lang.String toString() Format this Files collection as a String.- Overrides:
- toStringin class- AbstractSelectorContainer
- Returns:
- a descriptive String.
 
 - 
clonepublic java.lang.Object 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).- Overrides:
- clonein class- AbstractSelectorContainer
- Returns:
- a cloned Object.
 
 - 
mergeIncludespublic java.lang.String[] mergeIncludes(Project p) Get the merged include patterns for this Files collection.- Parameters:
- p- Project instance.
- Returns:
- the include patterns of the default pattern set and all nested patternsets.
 
 - 
mergeExcludespublic java.lang.String[] mergeExcludes(Project p) Get the merged exclude patterns for this Files collection.- Parameters:
- p- Project instance.
- Returns:
- the exclude patterns of the default pattern set and all nested patternsets.
 
 - 
mergePatternspublic PatternSet mergePatterns(Project p) Get the merged patterns for this Files collection.- Parameters:
- p- Project instance.
- Returns:
- the default patternset merged with the additional sets in a new PatternSet instance.
 
 - 
isFilesystemOnlypublic boolean isFilesystemOnly() Always returns true.- Specified by:
- isFilesystemOnlyin interface- ResourceCollection
- Returns:
- true indicating that all elements of a Files collection will be FileResources.
 
 - 
getRefprotected Files getRef() Perform the check for circular references and return the referenced Files collection.- Returns:
- FileCollection.
 
 
- 
 
-