Package org.gradle.api.tasks
Interface TaskInputPropertyBuilder
-
- All Superinterfaces:
CompatibilityAdapterForTaskInputs
,TaskInputs
,TaskPropertyBuilder
@Incubating public interface TaskInputPropertyBuilder extends TaskPropertyBuilder, TaskInputs
Describes an input property of a task.- Since:
- 4.3
-
-
Method Summary
-
-
-
Method Detail
-
optional
TaskInputPropertyBuilder optional(boolean optional)
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.
-
getHasInputs
@Deprecated boolean getHasInputs()
Deprecated.UseTaskInputs.getHasInputs()
directly instead.ThrowsUnsupportedOperationException
.- Specified by:
getHasInputs
in interfaceTaskInputs
- Returns:
- true if this task has declared any inputs.
-
getFiles
@Deprecated FileCollection getFiles()
Deprecated.UseTaskInputs.getFiles()
directly instead.ThrowsUnsupportedOperationException
.- Specified by:
getFiles
in interfaceTaskInputs
- Returns:
- The input files. Returns an empty collection if this task has no input files.
-
files
@Deprecated TaskInputFilePropertyBuilder files(Object... paths)
Deprecated.UseTaskInputs.files(Object...)
directly instead.ThrowsUnsupportedOperationException
.- Specified by:
files
in interfaceCompatibilityAdapterForTaskInputs
- Specified by:
files
in interfaceTaskInputs
- Parameters:
paths
- The input files. The given paths are evaluated as perProject.files(Object...)
.- Returns:
- a property builder to further configure the property.
-
file
@Deprecated TaskInputFilePropertyBuilder file(Object path)
Deprecated.UseTaskInputs.file(Object)
directly instead.ThrowsUnsupportedOperationException
.- Specified by:
file
in interfaceCompatibilityAdapterForTaskInputs
- Specified by:
file
in interfaceTaskInputs
- Parameters:
path
- The input file. The given path is evaluated as perProject.file(Object)
.- Returns:
- a property builder to further configure the property.
-
dir
@Deprecated TaskInputFilePropertyBuilder dir(Object dirPath)
Deprecated.UseTaskInputs.dir(Object)
directly instead.ThrowsUnsupportedOperationException
.- Specified by:
dir
in interfaceCompatibilityAdapterForTaskInputs
- Specified by:
dir
in interfaceTaskInputs
- Parameters:
dirPath
- The directory. The path is evaluated as perProject.file(Object)
.- Returns:
- a property builder to further configure the property.
-
getProperties
@Deprecated Map<String,Object> getProperties()
Deprecated.UseTaskInputs.getProperties()
directly instead.ThrowsUnsupportedOperationException
.- Specified by:
getProperties
in interfaceTaskInputs
- Returns:
- The properties.
-
property
@Deprecated TaskInputPropertyBuilder property(String name, Object value)
Deprecated.UseTaskInputs.property(String, Object)
directly instead.ThrowsUnsupportedOperationException
.- Specified by:
property
in interfaceCompatibilityAdapterForTaskInputs
- Specified by:
property
in interfaceTaskInputs
- Parameters:
name
- The name of the property. Must not be null.value
- The value for the property. Can be null.
-
properties
@Deprecated TaskInputs properties(Map<String,?> properties)
Deprecated.UseTaskInputs.properties(Map)
directly instead.ThrowsUnsupportedOperationException
.- Specified by:
properties
in interfaceTaskInputs
- Parameters:
properties
- The properties.
-
getHasSourceFiles
@Deprecated boolean getHasSourceFiles()
Deprecated.UseTaskInputs.getHasSourceFiles()
directly instead.ThrowsUnsupportedOperationException
.- Specified by:
getHasSourceFiles
in interfaceTaskInputs
- Returns:
- true if this task has source files, false if not.
-
getSourceFiles
@Deprecated FileCollection getSourceFiles()
Deprecated.UseTaskInputs.getSourceFiles()
directly instead.ThrowsUnsupportedOperationException
.- Specified by:
getSourceFiles
in interfaceTaskInputs
- Returns:
- The set of source files for this task.
-
-