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 using ObjectFactory.fileProperty().

Note: This interface is not intended for implementation by build script or plugin authors.

Since:
4.3

  • Method Details

    • getAsFile

      Provider<File> getAsFile()
      Views the location of this file as a File.

    • set

      void set(@Nullable File file)
      Sets the location of this file, using a File instance.

    • 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 interface Property<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 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