AntBuilderAware
, Buildable
, Iterable<File>
AntlrSourceDirectorySet
, ConfigurableFileCollection
, ConfigurableFileTree
, Configuration
, FileTree
, GroovySourceDirectorySet
, ScalaSourceDirectorySet
, SourceDirectorySet
, SourceSetOutput
public interface FileCollection extends Iterable<File>, AntBuilderAware, Buildable
A FileCollection
represents a collection of file system locations which you can query in certain ways. A file collection
is can be used to define a classpath, or a set of source files, or to add files to an archive.
There are no methods on this interface that allow the contents of the collection to be modified. However, there are a number of sub-interfaces, such as ConfigurableFileCollection
that
allow changes to be made.
A file collection may contain task outputs. The file collection tracks not just a set of files, but also the tasks that produce those files. When a file collection is used as a task input property, Gradle will take care of automatically adding dependencies between the consuming task and the producing tasks.
You can obtain a FileCollection
instance using Project.files(java.lang.Object...)
.
Modifier and Type | Interface | Description |
---|---|---|
static class |
FileCollection.AntType |
Ant types which a
FileCollection can be mapped to. |
Modifier and Type | Method | Description |
---|---|---|
Object |
addToAntBuilder(Object builder,
String nodeName) |
Adds this collection to an Ant task as a nested node.
|
void |
addToAntBuilder(Object builder,
String nodeName,
FileCollection.AntType type) |
Adds this collection to an Ant task as a nested node.
|
boolean |
contains(File file) |
Determines whether this collection contains the given file.
|
FileCollection |
filter(Closure filterClosure) |
Restricts the contents of this collection to those files which match the given criteria.
|
FileCollection |
filter(Spec<? super File> filterSpec) |
Restricts the contents of this collection to those files which match the given criteria.
|
FileTree |
getAsFileTree() |
Converts this collection to a
FileTree , if not already. |
String |
getAsPath() |
Returns the contents of this collection as a platform-specific path.
|
Provider<Set<FileSystemLocation>> |
getElements() |
Returns the contents of this file collection as a
Provider of FileSystemLocation instances. |
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) |
Returns a
FileCollection which contains the difference between this collection and the given
collection. |
FileCollection |
plus(FileCollection collection) |
Returns a
FileCollection which contains the union of this collection and the given collection. |
getBuildDependencies
forEach, iterator, spliterator
File getSingleFile() throws IllegalStateException
IllegalStateException
- when this collection does not contain exactly one file.Set<File> getFiles()
Set
. The contents of a file collection may change over time.
Note that this method returns File
objects that represent locations on the file system. These File
objects do not necessarily refer to regular files.
Depending on the implementation of this file collection and how it has been configured, the returned set may contain directories, or missing files, or any other kind of
file system element.
boolean contains(File file)
getFiles().contains(file)
.file
- The file to check for.String getAsPath()
FileCollection plus(FileCollection collection)
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.FileCollection minus(FileCollection collection)
Returns a FileCollection
which contains the difference between 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.FileCollection filter(Closure filterClosure)
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 @{link File} as a parameter, and should return a boolean value. The closure should return true
to include the file in the result and false
to exclude the file from the result.
filterClosure
- The closure to use to select the contents of the filtered collection.FileCollection filter(Spec<? super File> filterSpec)
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.boolean isEmpty()
getFiles().isEmpty()
.FileTree getAsFileTree()
FileTree
, if not already. 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.
The returned FileTree
is live, and tracks changes to this file collection and the producer tasks of this file collection.
FileTree
. Never returns null.Provider<Set<FileSystemLocation>> getElements()
Provider
of FileSystemLocation
instances. See getFiles()
for more details.
The returned Provider
is live, and tracks changes to this file collection and the producer tasks of this file collection.
void addToAntBuilder(Object builder, String nodeName, FileCollection.AntType type)
FileCollection.AntType.MatchingTask
: adds this collection to an Ant MatchingTask. The collection is converted to a
set of source directories and include and exclude patterns. The source directories as added as an Ant Path with
the given node name. The patterns are added using 'include' and 'exclude' nodes.FileCollection.AntType.FileSet
: adds this collection as zero or more Ant FileSets with the given node name.FileCollection.AntType.ResourceCollection
: adds this collection as zero or more Ant ResourceCollections with the
given node name.FileCollection.AntType.ResourceCollection
, if the target Ant task supports it, as this is
generally the most efficient. Using the other types may involve copying the contents of this collection to a
temporary directory.builder
- The builder to add this collection to.nodeName
- The target node name.type
- The target Ant typeObject addToAntBuilder(Object builder, String nodeName)
addToAntBuilder(builder,
nodeName,AntType.ResourceCollection)
.addToAntBuilder
in interface AntBuilderAware