FileSystemLocationProperty (Gradle API 5.6.1)
Date: 2019-09-03

Package org.gradle.api.file

## Interface FileSystemLocationProperty<T extends FileSystemLocation>

- Type Parameters:
    `T` - The type of location.
  All Superinterfaces:
    `HasConfigurableValue`, `Property<T>`, `Provider<T>`
  All Known Subinterfaces:
    `DirectoryProperty`, `RegularFileProperty`

      @Incubating
      public interface FileSystemLocationProperty<T extends FileSystemLocation>
      extends Property<T>

  Represents some element of the file system. A file system element has two parts: its location and its content. A file system element, or more accurately, its content, may be the output of a task or tasks. This property object keeps track of both the location and the task or tasks that produce the content of the element.

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

  Since:
    5.6

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `Provider<File>` | `getAsFile()` | Views the location of this file as a `File`.
    `Provider<T>` | `getLocationOnly()` | Returns the location of the file system element, and discards details of the task that produces its content.
    `void` | `set​(File file)` | Sets the location of this file, using a `File` instance.

    - ### Methods inherited from interface org.gradle.api.provider.HasConfigurableValue

      `disallowChanges`

    - ### Methods inherited from interface org.gradle.api.provider.Property

      `convention, convention, finalizeValue, set, set, value, value`

    - ### Methods inherited from interface org.gradle.api.provider.Provider

      `flatMap, get, getOrElse, getOrNull, isPresent, map, orElse, orElse`

- - ### Method Detail

    - #### 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.

    - #### getLocationOnly

          Provider<T> getLocationOnly()

      Returns the location of the file system element, and discards details of the task that produces its content. This allows the location, or a value derived from it, to be used as an input to some other task without implying any dependency on the producing task. This should only be used when the task does, in fact, not use the content of this file system element.