# ConfigurableFileCollection

@SupportsKotlinAssignmentOverloading
interface ConfigurableFileCollection : FileCollection, HasConfigurableValue, SupportsConvention(source)

A `ConfigurableFileCollection` is a mutable `FileCollection`.

You can obtain an instance of `ConfigurableFileCollection` by calling files or fileCollection.

Note: This interface is not intended for implementation by build script or plugin authors.

## Functions

addToAntBuilder
Link copied to clipboard
abstract fun addToAntBuilder(builder: Any, nodeName: String): Any
abstract fun addToAntBuilder(builder: Any, nodeName: String, type: FileCollection.AntType)
assign
Link copied to clipboard
fun ConfigurableFileCollection.assign(fileCollection: FileCollection)

Sets the ConfigurableFileCollection to contain the source paths of passed collection. This is the same as calling ConfigurableFileCollection.setFrom(fileCollection: FileCollection).

builtBy
Link copied to clipboard
abstract fun builtBy(tasks: Array<Any>): ConfigurableFileCollection
Registers some tasks which build the files of this collection.
contains
Link copied to clipboard
abstract fun contains(file: File): Boolean
convention
Link copied to clipboard
@Incubating
abstract fun convention(paths: Iterable<out Any>): ConfigurableFileCollection
@Incubating
abstract fun convention(paths: Array<Any>): ConfigurableFileCollection
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.
disallowChanges
Link copied to clipboard
abstract fun disallowChanges()
disallowUnsafeRead
Link copied to clipboard
abstract fun disallowUnsafeRead()
filter
Link copied to clipboard
abstract fun filter(filterClosure: Closure): FileCollection
finalizeValue
Link copied to clipboard
abstract fun finalizeValue()
finalizeValueOnRead
Link copied to clipboard
abstract fun finalizeValueOnRead()
forEach
Link copied to clipboard
open fun forEach(action: Consumer<in T>)
from
Link copied to clipboard
abstract fun from(paths: Array<Any>): ConfigurableFileCollection
Adds a set of source paths to this collection.
getAsFileTree
Link copied to clipboard
abstract fun getAsFileTree(): FileTree
getAsPath
Link copied to clipboard
abstract fun getAsPath(): String
getBuildDependencies
Link copied to clipboard
abstract fun getBuildDependencies(): TaskDependency
getBuiltBy
Link copied to clipboard
abstract fun getBuiltBy(): Set<Any>
Returns the set of tasks which build the files of this collection.
getElements
Link copied to clipboard
abstract fun getElements(): Provider<Set<FileSystemLocation>>
getFiles
Link copied to clipboard
abstract fun getFiles(): Set<File>
getFrom
Link copied to clipboard
abstract fun getFrom(): Set<Any>
Returns the set of source paths for this collection.
getSingleFile
Link copied to clipboard
abstract fun getSingleFile(): File
getValue
Link copied to clipboard
operator fun ConfigurableFileCollection.getValue(receiver: Any?, property: KProperty<*>): ConfigurableFileCollection

Property delegate for ConfigurableFileCollection instances.

isEmpty
Link copied to clipboard
abstract fun isEmpty(): Boolean
iterator
Link copied to clipboard
abstract fun iterator(): Iterator<T>
minus
Link copied to clipboard
abstract fun minus(collection: FileCollection): FileCollection
plus
Link copied to clipboard
abstract fun plus(collection: FileCollection): FileCollection
setBuiltBy
Link copied to clipboard
abstract fun setBuiltBy(tasks: Iterable<out Any>): ConfigurableFileCollection
Sets the tasks which build the files of this collection.
setFrom
Link copied to clipboard
abstract fun setFrom(paths: Iterable<out Any>)
abstract fun setFrom(paths: Array<Any>)
Sets the source paths for this collection.
setValue
Link copied to clipboard
operator fun ConfigurableFileCollection.setValue(receiver: Any?, property: KProperty<*>, value: Iterable<*>)

Property delegate for ConfigurableFileCollection instances.

spliterator
Link copied to clipboard
open fun spliterator(): Spliterator<T>
unset
Link copied to clipboard
abstract fun unset(): SupportsConvention
unsetConvention
Link copied to clipboard
abstract fun unsetConvention(): SupportsConvention