Package org.gradle.api.file
Interface RegularFileProperty
-
- All Superinterfaces:
Property<RegularFile>
,Provider<RegularFile>
@Incubating public interface RegularFileProperty extends Property<RegularFile>
Represents some configurable regular file location, whose value is mutable.You can create a
RegularFileProperty
usingObjectFactory.fileProperty()
.Note: This interface is not intended for implementation by build script or plugin authors.
- Since:
- 4.3
-
-
Method Summary
All Methods Instance Methods Abstract Methods 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.Provider<File>
getAsFile()
Views the location of this file as aFile
.void
set(File file)
Sets the location of this file, using aFile
instance.RegularFileProperty
value(RegularFile value)
Sets the value of the property the given value, replacing whatever value the property already had.-
Methods inherited from interface org.gradle.api.provider.Property
finalizeValue, set, set
-
-
-
-
Method Detail
-
value
RegularFileProperty value(RegularFile 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:
value
in interfaceProperty<RegularFile>
- Parameters:
value
- The value, can be null.- Returns:
- this
-
convention
RegularFileProperty convention(RegularFile value)
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:
convention
in interfaceProperty<RegularFile>
- Parameters:
value
- The value.- Returns:
- this
-
convention
RegularFileProperty convention(Provider<? extends RegularFile> valueProvider)
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:
convention
in interfaceProperty<RegularFile>
- Parameters:
valueProvider
- The provider of the value.- Returns:
- this
-
-