Package org.apache.tools.ant.types
Class FileList
- java.lang.Object
- 
- org.apache.tools.ant.ProjectComponent
- 
- org.apache.tools.ant.types.DataType
- 
- org.apache.tools.ant.types.FileList
 
 
 
- 
- All Implemented Interfaces:
- java.lang.Cloneable,- java.lang.Iterable<Resource>,- ResourceCollection
 
 public class FileList extends DataType implements ResourceCollection FileList represents an explicitly named list of files. FileLists are useful when you want to capture a list of files regardless of whether they currently exist. By contrast, FileSet operates as a filter, only returning the name of a matched file if it currently exists in the file system.
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classFileList.FileNameInner class corresponding to the <file> nested element.
 - 
Field Summary- 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Method SummaryModifier and Type Method Description voidaddConfiguredFile(FileList.FileName name)Add a nested <file> nested element.java.io.FilegetDir(Project p)java.lang.String[]getFiles(Project p)Returns the list of files represented by this FileList.booleanisFilesystemOnly()Always returns true.java.util.Iterator<Resource>iterator()Fulfill the ResourceCollection contract.voidsetDir(java.io.File dir)Set the dir attribute.voidsetFiles(java.lang.String filenames)Set the filenames attribute.voidsetRefid(Reference r)Makes this instance in effect a reference to another FileList instance.intsize()Fulfill the ResourceCollection contract.- 
Methods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toString
 - 
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- 
FileListpublic FileList() The default constructor.
 - 
FileListprotected FileList(FileList filelist) A copy constructor.- Parameters:
- filelist- a- FileListvalue
 
 
- 
 - 
Method Detail- 
setRefidpublic void setRefid(Reference r) throws BuildException Makes this instance in effect a reference to another FileList 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 reference to another filelist.
- Throws:
- BuildException- if an error occurs.
 
 - 
setDirpublic void setDir(java.io.File dir) throws BuildExceptionSet the dir attribute.- Parameters:
- dir- the directory this filelist is relative to.
- Throws:
- BuildException- if an error occurs
 
 - 
getDirpublic java.io.File getDir(Project p) - Parameters:
- p- the current project
- Returns:
- the directory attribute
 
 - 
setFilespublic void setFiles(java.lang.String filenames) Set the filenames attribute.- Parameters:
- filenames- a string containing filenames, separated by comma or by whitespace.
 
 - 
getFilespublic java.lang.String[] getFiles(Project p) Returns the list of files represented by this FileList.- Parameters:
- p- the current project
- Returns:
- the list of files represented by this FileList.
 
 - 
addConfiguredFilepublic void addConfiguredFile(FileList.FileName name) Add a nested <file> nested element.- Parameters:
- name- a configured file element with a name.
- Since:
- Ant 1.6.2
 
 - 
iteratorpublic java.util.Iterator<Resource> iterator() Fulfill the ResourceCollection contract.- Specified by:
- iteratorin interface- java.lang.Iterable<Resource>
- Returns:
- an Iterator of Resources.
- Since:
- Ant 1.7
 
 - 
sizepublic int size() Fulfill the ResourceCollection contract.- Specified by:
- sizein interface- ResourceCollection
- Returns:
- number of elements as int.
- Since:
- Ant 1.7
 
 - 
isFilesystemOnlypublic boolean isFilesystemOnly() Always returns true.- Specified by:
- isFilesystemOnlyin interface- ResourceCollection
- Returns:
- true indicating that all elements will be FileResources.
- Since:
- Ant 1.7
 
 
- 
 
-