api / org.gradle.api.tasks / TaskInputFilePropertyBuilder

TaskInputFilePropertyBuilder

interface TaskInputFilePropertyBuilder : TaskFilePropertyBuilder, TaskInputs

Describes an input property of a task that contains zero or more files.

Since
3.0

Functions

dir

abstract fun dir(dirPath: Any): TaskInputFilePropertyBuilder

Throws UnsupportedOperationException.

file

abstract fun file(path: Any): TaskInputFilePropertyBuilder

Throws UnsupportedOperationException.

files

abstract fun files(vararg paths: Any): TaskInputFilePropertyBuilder

Throws UnsupportedOperationException.

getFiles

abstract fun getFiles(): FileCollection

Throws UnsupportedOperationException.

getHasInputs

abstract fun getHasInputs(): Boolean

Throws UnsupportedOperationException.

getHasSourceFiles

abstract fun getHasSourceFiles(): Boolean

Throws UnsupportedOperationException.

getProperties

abstract fun getProperties(): MutableMap<String, Any>

Throws UnsupportedOperationException.

getSourceFiles

abstract fun getSourceFiles(): FileCollection

Throws UnsupportedOperationException.

optional

abstract fun optional(): TaskInputFilePropertyBuilder

Marks a task property as optional. This means that a value does not have to be specified for the property, but any value specified must meet the validation constraints for the property.

abstract fun optional(optional: Boolean): TaskInputFilePropertyBuilder

Sets whether the task property is optional. If the task property is optional, it means that a value does not have to be specified for the property, but any value specified must meet the validation constraints for the property.

properties

abstract fun properties(properties: MutableMap<String, *>): TaskInputs

Throws UnsupportedOperationException.

property

abstract fun property(name: String, value: Any): TaskInputPropertyBuilder

Throws UnsupportedOperationException.

skipWhenEmpty

abstract fun skipWhenEmpty(): TaskInputFilePropertyBuilder

Skip executing the task if the property contains no files. If there are multiple properties with {code skipWhenEmpty = true}, then they all need to be empty for the task to be skipped.

abstract fun skipWhenEmpty(skipWhenEmpty: Boolean): TaskInputFilePropertyBuilder

Sets whether executing the task should be skipped if the property contains no files. If there are multiple properties with {code skipWhenEmpty = true}, then they all need to be empty for the task to be skipped.

withNormalizer

abstract fun withNormalizer(normalizer: Class<out FileNormalizer>): TaskInputFilePropertyBuilder

Sets the normalizer to use for this property.

withPathSensitivity

abstract fun withPathSensitivity(sensitivity: PathSensitivity): TaskInputFilePropertyBuilder

Sets which part of the path of files should be considered during up-to-date checks.

withPropertyName

abstract fun withPropertyName(propertyName: String): TaskInputFilePropertyBuilder

{@inheritDoc}