FileSystemLocationProperty<RegularFile>, HasConfigurableValue, Property<RegularFile>, Provider<RegularFile>, SupportsConventionpublic interface RegularFileProperty extends FileSystemLocationProperty<RegularFile>
You can create a RegularFileProperty using ObjectFactory.fileProperty().
Note: This interface is not intended for implementation by build script or plugin authors.
| Modifier and Type | Method | Description |
|---|---|---|
RegularFileProperty |
convention(RegularFile value) |
Specifies the value to use as the convention (default value) for this property.
|
RegularFileProperty |
convention(Provider<? extends RegularFile> provider) |
Specifies the provider to be used to query the convention (default value) for this property.
|
RegularFileProperty |
fileProvider(Provider<java.io.File> provider) |
Sets the location of this file, using a
File Provider instance. |
RegularFileProperty |
fileValue(java.io.File file) |
Sets the location of this file, using a
File instance. |
RegularFileProperty |
value(RegularFile value) |
Sets the value of the property to the given value, replacing whatever value the property already had.
|
RegularFileProperty |
value(Provider<? extends RegularFile> provider) |
Sets the property to have the same value as the given provider, replacing whatever value the property already had.
|
getAsFile, getLocationOnly, setdisallowChanges, disallowUnsafeRead, finalizeValueOnReadfinalizeValue, set, set, unset, unsetConventionRegularFileProperty value(@Nullable RegularFile value)
Property.set(Object) but returns this property to allow method chaining.
This method can also be used to discard the value of the property, by passing it null.
When the value is discarded (or has never been set in the first place), the convention (default value)
for this property, if specified, will be used to provide the value instead.
value in interface Property<RegularFile>value - The value, can be null.RegularFileProperty value(Provider<? extends RegularFile> provider)
Property.set(Provider)
but returns this property to allow method chaining.
This method can NOT be used to discard the value of the property. Specifying a null provider will result
in an IllegalArgumentException being thrown. When the provider has no value, this property will also have
no value - regardless of whether or not a convention has been set.
When the given provider represents a task output, this property will also carry the task dependency information from the provider.
value in interface Property<RegularFile>provider - The provider whose value to use.RegularFileProperty fileValue(@Nullable java.io.File file)
File instance. File instances with relative paths are resolved relative to the project directory of the project
that owns this property instance.
This method is the same as FileSystemLocationProperty.set(File) but allows method chaining.
fileValue in interface FileSystemLocationProperty<RegularFile>RegularFileProperty fileProvider(Provider<java.io.File> provider)
File Provider instance. File instances with relative paths are resolved relative to the project directory of the project
that owns this property instance.fileProvider in interface FileSystemLocationProperty<RegularFile>RegularFileProperty convention(@Nullable RegularFile value)
This method can be used to specify that the property does not have a default value, by passing it
null.
convention in interface Property<RegularFile>value - The convention value, or null if the property should have no default value.RegularFileProperty convention(Provider<? extends RegularFile> provider)
The property's convention tracks the convention provider. Whenever the convention's actual value is needed, the convention provider will be queried anew.
This method can't be used to specify that a property does not have a default value. Passing in a null
provider will result in an IllegalArgumentException being thrown. When the provider doesn't have
a value, then the property will behave as if it wouldn't have a convention specified.
convention in interface Property<RegularFile>provider - The provider of the property's convention value, can't be null.