Interface RegularFileProperty

All Superinterfaces:
FileSystemLocationProperty<RegularFile>, HasConfigurableValue, Property<RegularFile>, Provider<RegularFile>

@Incubating public interface RegularFileProperty extends FileSystemLocationProperty<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 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:
      value in interface Property<RegularFile>
      Parameters:
      value - The value, can be null.
      Returns:
      this
    • value

      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. 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:
      value in interface Property<RegularFile>
      Parameters:
      provider - The provider whose value to use.
      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 interface Property<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 interface Property<RegularFile>
      Parameters:
      valueProvider - The provider of the value.
      Returns:
      this