FileSystemLocationProperty<RegularFile>
, HasConfigurableValue
, Property<RegularFile>
, Provider<RegularFile>
public 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 for this property.
|
RegularFileProperty |
convention(Provider<? extends RegularFile> valueProvider) |
Specifies the provider of the value to use as the convention for this property.
|
RegularFileProperty |
fileProvider(Provider<File> provider) |
|
RegularFileProperty |
fileValue(File file) |
Sets the location of this file, using a
File instance. |
RegularFileProperty |
value(RegularFile value) |
Sets the value of the property the given value, replacing whatever value the property already had.
|
RegularFileProperty |
value(Provider<? extends RegularFile> provider) |
Sets the property to have the same value of the given provider, replacing whatever value the property already had.
|
getAsFile, getLocationOnly, set
disallowChanges, disallowUnsafeRead, finalizeValueOnRead
finalizeValue, set, set
RegularFileProperty value(@Nullable RegularFile value)
This is the same as Property.set(Object)
but returns this property to allow method chaining.
value
in interface Property<RegularFile>
value
- The value, can be null.RegularFileProperty value(Provider<? extends RegularFile> provider)
This is the same as Property.set(Provider)
but returns this property to allow method chaining.
value
in interface Property<RegularFile>
provider
- The provider whose value to use.RegularFileProperty fileValue(@Nullable 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<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(RegularFile value)
convention
in interface Property<RegularFile>
value
- The value, or null
if the convention is that the property should have no value.RegularFileProperty convention(Provider<? extends RegularFile> valueProvider)
convention
in interface Property<RegularFile>
valueProvider
- The provider of the value.