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 Summary
Nested Classes Modifier and Type Class Description static classFileList.FileNameInner class corresponding to the <file> nested element. -
Field Summary
-
Constructor Summary
-
Method Summary
Modifier 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.DataType
checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toStringMethods inherited from class org.apache.tools.ant.ProjectComponent
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
-
Constructor Details
-
Method Details
-
setRefid
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 classDataType- Parameters:
r- the reference to another filelist.- Throws:
BuildException- if an error occurs.
-
setDir
Set the dir attribute.- Parameters:
dir- the directory this filelist is relative to.- Throws:
BuildException- if an error occurs
-
getDir
- Parameters:
p- the current project- Returns:
- the directory attribute
-
setFiles
public void setFiles(java.lang.String filenames)Set the filenames attribute.- Parameters:
filenames- a string containing filenames, separated by comma or by whitespace.
-
getFiles
Returns the list of files represented by this FileList.- Parameters:
p- the current project- Returns:
- the list of files represented by this FileList.
-
addConfiguredFile
Add a nested <file> nested element.- Parameters:
name- a configured file element with a name.- Since:
- Ant 1.6.2
-
iterator
Fulfill the ResourceCollection contract.- Specified by:
iteratorin interfacejava.lang.Iterable<Resource>- Returns:
- an Iterator of Resources.
- Since:
- Ant 1.7
-
size
public int size()Fulfill the ResourceCollection contract.- Specified by:
sizein interfaceResourceCollection- Returns:
- number of elements as int.
- Since:
- Ant 1.7
-
isFilesystemOnly
public boolean isFilesystemOnly()Always returns true.- Specified by:
isFilesystemOnlyin interfaceResourceCollection- Returns:
- true indicating that all elements will be FileResources.
- Since:
- Ant 1.7
-