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:
- Cloneable,- Iterable<Resource>,- ResourceCollection,- SelectorContainer
ResourceCollection implementation; like AbstractFileSet with absolute paths.
- Since:
- Ant 1.7
- 
Field SummaryFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidappendExcludes(String[] excludes) Appendexcludesto the current list of include patterns.voidappendIncludes(String[] includes) Appendincludesto the current list of include patterns.voidappendSelector(FileSelector selector) Add a new selector into this container.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).Add a name entry to the exclude list.Add a name entry to the excludes files list.Add a name entry to the include list.Add a name entry to the include files list.Create a nested patternset.booleanGet whether default exclusions should be used or not.protected FilesgetRef()Perform the check for circular references and return the referenced Files collection.booleanFind out whether this Files collection has patterns.booleanFind out if this Files collection is case-sensitive.booleanAlways returns true.booleanFind out whether symbolic links should be followed.iterator()Fulfill the ResourceCollection contract.String[]Get the merged exclude patterns for this Files collection.String[]Get the merged include patterns for this Files collection.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(String excludes) Appendexcludesto the current list of exclude patterns.voidsetExcludesfile(File excl) Set theFilecontaining the excludes patterns.voidsetFollowSymlinks(boolean followSymlinks) Set whether or not symbolic links should be followed.voidsetIncludes(String includes) Appendincludesto the current list of include patterns.voidsetIncludesfile(File incl) Set theFilecontaining the includes patterns.voidMake this instance in effect a reference to another instance.intsize()Fulfill the ResourceCollection contract.toString()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, validateMethods 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, tooManyAttributesMethods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProjectMethods inherited from class java.lang.Objectequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.IterableforEach, spliteratorMethods inherited from interface org.apache.tools.ant.types.ResourceCollectionisEmpty, stream
- 
Constructor Details- 
Filespublic Files()Construct a newFilescollection.
- 
FilesConstruct a newFilescollection, shallowly cloned from the specifiedFiles.- Parameters:
- f- the- Filesto use as a template.
 
 
- 
- 
Method Details- 
setRefidMake 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.
 
- 
createPatternSetCreate a nested patternset.- Returns:
- PatternSet.
 
- 
createIncludeAdd a name entry to the include list.- Returns:
- PatternSet.NameEntry.
 
- 
createIncludesFileAdd a name entry to the include files list.- Returns:
- PatternSet.PatternFileNameEntry.
 
- 
createExcludeAdd a name entry to the exclude list.- Returns:
- PatternSet.NameEntry.
 
- 
createExcludesFileAdd a name entry to the excludes files list.- Returns:
- PatternSet.PatternFileNameEntry.
 
- 
setIncludesAppendincludesto the current list of include patterns.Patterns may be separated by a comma or a space. - Parameters:
- includes- the- Stringcontaining the include patterns.
 
- 
appendIncludesAppendincludesto the current list of include patterns.- Parameters:
- includes- array containing the include patterns.
 
- 
setExcludesAppendexcludesto the current list of exclude patterns.Patterns may be separated by a comma or a space. - Parameters:
- excludes- the- Stringcontaining the exclude patterns.
 
- 
appendExcludesAppendexcludesto the current list of include patterns.- Parameters:
- excludes- array containing the exclude patterns.
 
- 
setIncludesfileSet theFilecontaining the includes patterns.- Parameters:
- incl-- Fileinstance.
- Throws:
- BuildException- if there is a problem.
 
- 
setExcludesfileSet 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.
 
- 
iteratorFulfill the ResourceCollection contract.
- 
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.
 
- 
appendSelectorAdd a new selector into this container.- Specified by:
- appendSelectorin interface- SelectorContainer
- Overrides:
- appendSelectorin class- AbstractSelectorContainer
- Parameters:
- selector- the new- FileSelectorto add.
 
- 
toStringFormat this Files collection as a String.- Overrides:
- toStringin class- AbstractSelectorContainer
- Returns:
- a descriptive String.
 
- 
cloneCreate 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.
 
- 
mergeIncludesGet 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.
 
- 
mergeExcludesGet 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.
 
- 
mergePatternsGet 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.
 
- 
getRefPerform the check for circular references and return the referenced Files collection.- Returns:
- FileCollection.
 
 
-