Package org.gradle.api.file
Interface ConfigurableFileCollection
- All Superinterfaces:
AntBuilderAware,Buildable,FileCollection,HasConfigurableValue,Iterable<File>,SupportsConvention
@SupportsKotlinAssignmentOverloading
public interface ConfigurableFileCollection
extends FileCollection, HasConfigurableValue, SupportsConvention
A ConfigurableFileCollection is a mutable FileCollection.
You can obtain an instance of ConfigurableFileCollection by calling Project.files(Object...) or ObjectFactory.fileCollection().
Note: This interface is not intended for implementation by build script or plugin authors.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.gradle.api.file.FileCollection
FileCollection.AntType -
Method Summary
Modifier and TypeMethodDescriptionRegisters some tasks which build the files of this collection.convention(Iterable<?> paths) Specifies the value to use as the convention (default value) to be used when resolving this file collection, if no source paths are explicitly defined.convention(Object... paths) Specifies the value to use as the convention (default value) to be used when resolving this file collection, if no source paths are explicitly defined.Adds a set of source paths to this collection.Returns the set of tasks which build the files of this collection.getFrom()Returns the set of source paths for this collection.setBuiltBy(Iterable<?> tasks) Sets the tasks which build the files of this collection.voidSets the source paths for this collection.voidSets the source paths for this collection.Methods inherited from interface org.gradle.api.Buildable
getBuildDependenciesMethods inherited from interface org.gradle.api.file.FileCollection
addToAntBuilder, addToAntBuilder, contains, filter, filter, getAsFileTree, getAsPath, getElements, getFiles, getSingleFile, isEmpty, minus, plusMethods inherited from interface org.gradle.api.provider.HasConfigurableValue
disallowChanges, disallowUnsafeRead, finalizeValue, finalizeValueOnReadMethods inherited from interface java.lang.Iterable
forEach, iterator, spliteratorMethods inherited from interface org.gradle.api.provider.SupportsConvention
unset, unsetConvention
-
Method Details
-
getFrom
Returns the set of source paths for this collection. The paths are evaluated as perProject.files(Object...).- Returns:
- The set of source paths. Returns an empty set if none.
-
setFrom
Sets the source paths for this collection. The given paths are evaluated as perProject.files(Object...).- Parameters:
paths- The paths.
-
setFrom
Sets the source paths for this collection. The given paths are evaluated as perProject.files(Object...).- Parameters:
paths- The paths.
-
convention
Specifies the value to use as the convention (default value) to be used when resolving this file collection, if no source paths are explicitly defined. If, at the time this method is invoked, the set of source paths for this collection is empty, the convention will be used to resolve this file collection.- Parameters:
paths- The paths.- Returns:
- this collection
- Since:
- 8.8
-
convention
Specifies the value to use as the convention (default value) to be used when resolving this file collection, if no source paths are explicitly defined. If, at the time this method is invoked, the set of source paths for this collection is empty, the convention will be used to resolve this file collection.- Parameters:
paths- The paths.- Returns:
- this collection
- Since:
- 8.8
-
from
Adds a set of source paths to this collection. The given paths are evaluated as perProject.files(Object...).- Parameters:
paths- The files to add.- Returns:
- this
-
getBuiltBy
Returns the set of tasks which build the files of this collection.- Returns:
- The set. Returns an empty set when there are no such tasks.
-
setBuiltBy
Sets the tasks which build the files of this collection.- Parameters:
tasks- The tasks. These are evaluated as perTask.dependsOn(Object...).- Returns:
- this
-
builtBy
Registers some tasks which build the files of this collection.- Parameters:
tasks- The tasks. These are evaluated as perTask.dependsOn(Object...).- Returns:
- this
-