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 Summary
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier 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.AbstractSelectorContainer
add, 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.DataType
checkAttributesAllowed, 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.ProjectComponent
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProjectMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, spliteratorMethods inherited from interface org.apache.tools.ant.types.ResourceCollection
isEmpty, stream
-
Constructor Details
-
Files
public Files()Construct a newFilescollection. -
Files
Construct a newFilescollection, shallowly cloned from the specifiedFiles.- Parameters:
f- theFilesto use as a template.
-
-
Method Details
-
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.
- Overrides:
setRefidin classDataType- Parameters:
r- theReferenceto use.- Throws:
BuildException- if there is a problem.
-
createPatternSet
-
createInclude
Add a name entry to the include list.- Returns:
PatternSet.NameEntry.
-
createIncludesFile
Add a name entry to the include files list.- Returns:
PatternSet.PatternFileNameEntry.
-
createExclude
Add a name entry to the exclude list.- Returns:
PatternSet.NameEntry.
-
createExcludesFile
Add a name entry to the excludes files list.- Returns:
PatternSet.PatternFileNameEntry.
-
setIncludes
Appendincludesto the current list of include patterns.Patterns may be separated by a comma or a space.
- Parameters:
includes- theStringcontaining the include patterns.
-
appendIncludes
Appendincludesto the current list of include patterns.- Parameters:
includes- array containing the include patterns.
-
setExcludes
Appendexcludesto the current list of exclude patterns.Patterns may be separated by a comma or a space.
- Parameters:
excludes- theStringcontaining the exclude patterns.
-
appendExcludes
Appendexcludesto the current list of include patterns.- Parameters:
excludes- array containing the exclude patterns.
-
setIncludesfile
Set theFilecontaining the includes patterns.- Parameters:
incl-Fileinstance.- Throws:
BuildException- if there is a problem.
-
setExcludesfile
Set theFilecontaining the excludes patterns.- Parameters:
excl-Fileinstance.- Throws:
BuildException- if there is a problem.
-
setDefaultexcludes
public void setDefaultexcludes(boolean useDefaultExcludes) Set whether default exclusions should be used or not.- Parameters:
useDefaultExcludes-boolean.
-
getDefaultexcludes
public boolean getDefaultexcludes()Get whether default exclusions should be used or not.- Returns:
- the defaultexclusions value.
-
setCaseSensitive
public void setCaseSensitive(boolean caseSensitive) Set case-sensitivity of the Files collection.- Parameters:
caseSensitive-boolean.
-
isCaseSensitive
public boolean isCaseSensitive()Find out if this Files collection is case-sensitive.- Returns:
booleanindicating whether the Files collection is case-sensitive.
-
setFollowSymlinks
public void setFollowSymlinks(boolean followSymlinks) Set whether or not symbolic links should be followed.- Parameters:
followSymlinks- whether or not symbolic links should be followed.
-
isFollowSymlinks
public boolean isFollowSymlinks()Find out whether symbolic links should be followed.- Returns:
booleanindicating whether symbolic links should be followed.
-
iterator
-
size
public int size()Fulfill the ResourceCollection contract.- Specified by:
sizein interfaceResourceCollection- Returns:
- number of elements as int.
-
hasPatterns
public boolean hasPatterns()Find out whether this Files collection has patterns.- Returns:
- whether any patterns are in this container.
-
appendSelector
Add a new selector into this container.- Specified by:
appendSelectorin interfaceSelectorContainer- Overrides:
appendSelectorin classAbstractSelectorContainer- Parameters:
selector- the newFileSelectorto add.
-
toString
Format this Files collection as a String.- Overrides:
toStringin classAbstractSelectorContainer- Returns:
- a descriptive
String.
-
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 classAbstractSelectorContainer- Returns:
- a cloned Object.
-
mergeIncludes
-
mergeExcludes
-
mergePatterns
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.
-
isFilesystemOnly
public boolean isFilesystemOnly()Always returns true.- Specified by:
isFilesystemOnlyin interfaceResourceCollection- Returns:
- true indicating that all elements of a Files collection will be FileResources.
-
getRef
Perform the check for circular references and return the referenced Files collection.- Returns:
FileCollection.
-