Interface RegularFileProperty
- All Superinterfaces:
FileSystemLocationProperty<RegularFile>, HasConfigurableValue, Property<RegularFile>, Provider<RegularFile>
Represents some configurable regular file location, whose value is mutable.
You can create a RegularFileProperty using ObjectFactory.fileProperty().
Note: This interface is not intended for implementation by build script or plugin authors.
- Since:
- 4.3
-
Method Summary
Modifier and TypeMethodDescriptionconvention(RegularFile value) Specifies the value to use as the convention for this property.convention(Provider<? extends RegularFile> valueProvider) Specifies the provider of the value to use as the convention for this property.value(RegularFile value) Sets the value of the property the given value, replacing whatever value the property already had.value(Provider<? extends RegularFile> provider) Sets the property to have the same value of the given provider, replacing whatever value the property already had.Methods inherited from interface FileSystemLocationProperty
getAsFile, getLocationOnly, setMethods inherited from interface HasConfigurableValue
disallowChangesMethods inherited from interface Property
finalizeValue, set, set
-
Method Details
-
value
Sets the value of the property the given value, replacing whatever value the property already had.This is the same as
Property.set(Object)but returns this property to allow method chaining.- Specified by:
valuein interfaceProperty<RegularFile>- Parameters:
value- The value, can be null.- Returns:
- this
-
value
Sets the property to have the same value of the given provider, replacing whatever value the property already had. This property will track the value of the provider and query its value each time the value of the property is queried. When the provider has no value, this property will also have no value.This is the same as
Property.set(Provider)but returns this property to allow method chaining.- Specified by:
valuein interfaceProperty<RegularFile>- Parameters:
provider- The provider whose value to use.- Returns:
- this
-
convention
Specifies the value to use as the convention for this property. The convention is used when no value has been set for this property.- Specified by:
conventionin interfaceProperty<RegularFile>- Parameters:
value- The value.- Returns:
- this
-
convention
Specifies the provider of the value to use as the convention for this property. The convention is used when no value has been set for this property.- Specified by:
conventionin interfaceProperty<RegularFile>- Parameters:
valueProvider- The provider of the value.- Returns:
- this
-