Package org.gradle.api.tasks
Interface TaskInputs
- All Superinterfaces:
CompatibilityAdapterForTaskInputs
- All Known Subinterfaces:
TaskInputFilePropertyBuilder
,TaskInputPropertyBuilder
A TaskInputs
represents the inputs for a task.
You can obtain a TaskInputs
instance using Task.getInputs()
.
-
Method Summary
Modifier and TypeMethodDescriptionRegisters an input directory hierarchy.Registers some input file for this task.Registers some input files for this task.getFiles()
Returns the input files of this task.boolean
Returns true if this task has declared the inputs that it consumes.boolean
Returns true if this task has declared that it accepts source files.Returns the set of input properties for this task.Returns the set of source files for this task.properties
(Map<String, ?> properties) Registers a set of input properties for this task.Registers an input property for this task.
-
Method Details
-
getHasInputs
boolean getHasInputs()Returns true if this task has declared the inputs that it consumes.- Returns:
- true if this task has declared any inputs.
-
getFiles
FileCollection getFiles()Returns the input files of this task.- Returns:
- The input files. Returns an empty collection if this task has no input files.
-
files
Registers some input files for this task.- Specified by:
files
in interfaceCompatibilityAdapterForTaskInputs
- Parameters:
paths
- The input files. The given paths are evaluated as perProject.files(Object...)
.- Returns:
- a property builder to further configure the property.
-
file
Registers some input file for this task.- Specified by:
file
in interfaceCompatibilityAdapterForTaskInputs
- Parameters:
path
- The input file. The given path is evaluated as perProject.file(Object)
.- Returns:
- a property builder to further configure the property.
-
dir
Registers an input directory hierarchy. All files found under the given directory are treated as input files for this task.- Specified by:
dir
in interfaceCompatibilityAdapterForTaskInputs
- Parameters:
dirPath
- The directory. The path is evaluated as perProject.file(Object)
.- Returns:
- a property builder to further configure the property.
-
getProperties
Returns the set of input properties for this task.- Returns:
- The properties.
-
property
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 orCallable
is executed to determine the actual property value.- Specified by:
property
in interfaceCompatibilityAdapterForTaskInputs
- Parameters:
name
- The name of the property. Must not be null.value
- The value for the property. Can be null.
-
properties
Registers a set of input properties for this task. Seeproperty(String, Object)
for details.Note: do not use the return value to chain calls. Instead always use call via
Task.getInputs()
.- Parameters:
properties
- The properties.
-
getHasSourceFiles
boolean getHasSourceFiles()Returns true if this task has declared that it accepts source files.- Returns:
- true if this task has source files, false if not.
-
getSourceFiles
FileCollection getSourceFiles()Returns the set of source files for this task. These are the subset of input files which the task actually does work on. A task is skipped if it has declared it accepts source files, and this collection is empty.- Returns:
- The set of source files for this task.
-