A FileCollection
represents a collection of files which you can query in certain ways. A file collection
is often used to define a classpath, or to add files to a container.
You can obtain a FileCollection
instance using Project.files.
Modifiers | Name | Description |
---|---|---|
enum |
FileCollection.AntType |
Ant types which a FileCollection can be mapped to. |
Type | Name and description |
---|---|
FileCollection |
add(FileCollection collection) |
void |
addToAntBuilder(Object builder, String nodeName, FileCollection.AntType type) |
Object |
addToAntBuilder(Object builder, String nodeName) Adds this collection to an Ant task as a nested node. |
Object |
asType(Class<?> type) |
boolean |
contains(File file) Determines whether this collection contains the given file. |
FileCollection |
filter(Closure filterClosure) |
FileCollection |
filter(Spec<? super File> filterSpec) |
FileTree |
getAsFileTree() Converts this collection to a FileTree. |
String |
getAsPath() Returns the contents of this collection as a platform-specific path. |
Set<File> |
getFiles() Returns the contents of this collection as a Set. |
File |
getSingleFile() Returns the content of this collection, asserting it contains exactly one file. |
boolean |
isEmpty() Returns true if this collection is empty. |
FileCollection |
minus(FileCollection collection) |
FileCollection |
plus(FileCollection collection) |
FileCollection |
stopExecutionIfEmpty() Throws a StopExecutionException if this collection is empty. |
Methods inherited from class | Name |
---|---|
interface Buildable |
getBuildDependencies |
interface Iterable |
iterator |
interface AntBuilderAware |
addToAntBuilder |
Adds another collection to this collection. This is an optional operation.
collection
- The collection to add.
A FileCollection
represents a collection of files which you can query in certain ways. A file collection
is often used to define a classpath, or to add files to a container.
You can obtain a FileCollection
instance using Project.files.
Adds this collection to an Ant task as a nested node. Equivalent to calling addToAntBuilder(builder,
nodeName,AntType.ResourceCollection)
.
Converts this collection into an object of the specified type. Supported types are: Collection
, List
, Set
, Object[]
, File[]
, File
, and FileTree.
You can call this method in your build script using the as
operator.
type
- The type to convert to. Determines whether this collection contains the given file. Generally, this method is more efficient than calling
getFiles().contains(file)
.
file
- The file to check for.
Restricts the contents of this collection to those files which match the given criteria. The filtered collection is live, so that it reflects any changes to this collection.
The given closure is passed the File as a parameter, and should return a boolean value.
filterClosure
- The closure to use to select the contents of the filtered collection.
Restricts the contents of this collection to those files which match the given criteria. The filtered collection is live, so that it reflects any changes to this collection.
filterSpec
- The criteria to use to select the contents of the filtered collection.Converts this collection to a FileTree. Generally, for each file in this collection, the resulting file tree will contain the source file at the root of the tree. For each directory in this collection, the resulting file tree will contain all the files under the source directory.
Returns the contents of this collection as a platform-specific path. This can be used, for example, in an Ant
Returns the contents of this collection as a Set.
Returns the content of this collection, asserting it contains exactly one file.
Returns true if this collection is empty. Generally, calling this method is more efficient than calling getFiles().isEmpty()
.
Returns a FileCollection
which contains the intersection of this collection and the given collection.
The returned collection is live, and tracks changes to both source collections.
You can call this method in your build script using the -
operator.
collection
- The other collection. Should not be null.
Returns a FileCollection
which contains the union of this collection and the given collection. The
returned collection is live, and tracks changes to both source collections.
You can call this method in your build script using the +
operator.
collection
- The other collection. Should not be null.Throws a StopExecutionException if this collection is empty.