Package org.gradle.api.tasks
Interface TaskInputFilePropertyBuilder
- All Superinterfaces:
CompatibilityAdapterForTaskInputs
,TaskFilePropertyBuilder
,TaskInputs
,TaskPropertyBuilder
@Incubating
public interface TaskInputFilePropertyBuilder
extends TaskFilePropertyBuilder, TaskInputs
Describes an input property of a task that contains zero or more files.
- Since:
- 3.0
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Deprecated.UseTaskInputs.file(Object)
directly instead.Deprecated.UseTaskInputs.files(Object...)
directly instead.getFiles()
Deprecated.UseTaskInputs.getFiles()
directly instead.boolean
Deprecated.UseTaskInputs.getHasInputs()
directly instead.boolean
Deprecated.UseTaskInputs.getHasSourceFiles()
directly instead.Deprecated.UseTaskInputs.getProperties()
directly instead.Deprecated.UseTaskInputs.getSourceFiles()
directly instead.optional()
Marks a task property as optional.optional
(boolean optional) Sets whether the task property is optional.properties
(Map<String, ?> properties) Deprecated.UseTaskInputs.properties(Map)
directly instead.Deprecated.UseTaskInputs.property(String, Object)
directly instead.Skip executing the task if the property contains no files.skipWhenEmpty
(boolean skipWhenEmpty) Sets whether executing the task should be skipped if the property contains no files.withNormalizer
(Class<? extends FileNormalizer> normalizer) Sets the normalizer to use for this property.withPathSensitivity
(PathSensitivity sensitivity) Sets which part of the path of files should be considered during up-to-date checks.withPropertyName
(String propertyName) Sets the name for this property.
-
Method Details
-
withPropertyName
Sets the name for this property. The name must be a valid Java identifier, or a series of valid Java identifiers separated with dots ('.').If the method is not called, or if it is called with
null
, a name will be assigned to the property automatically.- Specified by:
withPropertyName
in interfaceTaskFilePropertyBuilder
-
skipWhenEmpty
TaskInputFilePropertyBuilder skipWhenEmpty()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. -
skipWhenEmpty
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. -
optional
TaskInputFilePropertyBuilder optional()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. -
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. -
withPathSensitivity
Sets which part of the path of files should be considered during up-to-date checks.- Since:
- 3.1
-
withNormalizer
Sets the normalizer to use for this property.- Since:
- 4.3
-
getHasInputs
Deprecated.UseTaskInputs.getHasInputs()
directly instead.ThrowsUnsupportedOperationException
.- Specified by:
getHasInputs
in interfaceTaskInputs
- Returns:
- true if this task has declared any inputs.
-
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.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.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.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.UseTaskInputs.getProperties()
directly instead.ThrowsUnsupportedOperationException
.- Specified by:
getProperties
in interfaceTaskInputs
- Returns:
- The properties.
-
property
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.UseTaskInputs.properties(Map)
directly instead.ThrowsUnsupportedOperationException
.- Specified by:
properties
in interfaceTaskInputs
- Parameters:
properties
- The properties.
-
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.UseTaskInputs.getSourceFiles()
directly instead.ThrowsUnsupportedOperationException
.- Specified by:
getSourceFiles
in interfaceTaskInputs
- Returns:
- The set of source files for this task.
-
TaskInputs.dir(Object)
directly instead.