public interface TaskInputs extends CompatibilityAdapterForTaskInputs
A TaskInputs
represents the inputs for a task.
You can obtain a TaskInputs
instance using Task.getInputs()
.
Modifier and Type | Method and Description |
---|---|
TaskInputFilePropertyBuilder |
dir(Object dirPath)
Registers an input directory hierarchy.
|
TaskInputFilePropertyBuilder |
file(Object path)
Registers some input file for this task.
|
TaskInputFilePropertyBuilder |
files(Object... paths)
Registers some input files for this task.
|
FileCollection |
getFiles()
Returns the input files of this task.
|
boolean |
getHasInputs()
Returns true if this task has declared the inputs that it consumes.
|
boolean |
getHasSourceFiles()
Returns true if this task has declared that it accepts source files.
|
Map<String,Object> |
getProperties()
Returns the set of input properties for this task.
|
FileCollection |
getSourceFiles()
Returns the set of source files for this task.
|
TaskInputs |
properties(Map<String,?> properties)
Registers a set of input properties for this task.
|
TaskInputs |
property(String name,
Object value)
Registers an input property for this task.
|
TaskInputs |
source(Object... paths)
Deprecated.
|
TaskInputs |
source(Object path)
Deprecated.
|
TaskInputs |
sourceDir(Object path)
Deprecated.
|
boolean getHasInputs()
FileCollection getFiles()
TaskInputFilePropertyBuilder files(Object... paths)
files
in interface CompatibilityAdapterForTaskInputs
paths
- The input files. The given paths are evaluated as per Project.files(Object...)
.TaskInputFilePropertyBuilder file(Object path)
file
in interface CompatibilityAdapterForTaskInputs
path
- The input file. The given path is evaluated as per Project.files(Object...)
.TaskInputFilePropertyBuilder dir(Object dirPath)
dir
in interface CompatibilityAdapterForTaskInputs
dirPath
- The directory. The path is evaluated as per Project.file(Object)
.Map<String,Object> getProperties()
TaskInputs property(String name, Object value)
Registers an input property for this task. This value is persisted when the task executes, and is compared against the property value for later invocations of the task, to determine if the task is up-to-date.
The given value for the property must be Serializable, so that it can be persisted. It should also provide a
useful equals()
method.
You can specify a closure or Callable
as the value of the property. In which case, the closure or
Callable
is executed to determine the actual property value.
name
- The name of the property. Must not be null.value
- The value for the property. Can be null.TaskInputs properties(Map<String,?> properties)
property(String, Object)
for details.properties
- The properties.boolean getHasSourceFiles()
FileCollection getSourceFiles()
@Deprecated TaskInputs source(Object... paths)
files(Object...)
.paths
- The paths. These are evaluated as per Project.files(Object...)
.@Deprecated TaskInputs source(Object path)
files(Object...)
.path
- The path. This is evaluated as per Project.files(Object...)
.@Deprecated TaskInputs sourceDir(Object path)
dir(Object)
.path
- The path. This is evaluated as per Project.file(Object)
.