# FileSystemLocationProperty

interface FileSystemLocationProperty<T : FileSystemLocation?> : 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's 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

#### Parameters

<T>

The type of location.

#### Inheritors

DirectoryProperty
RegularFileProperty

## Functions

assign
Link copied to clipboard
fun <T : FileSystemLocation> FileSystemLocationProperty<T>.assign(file: File?)

Assign file to a FileSystemLocationProperty with assign operator

fun <T : FileSystemLocation> FileSystemLocationProperty<T>.assign(provider: Provider<File>)

Assign file provided by a Provider to a FileSystemLocationProperty with assign operator

fun <T : Any> Property<T>.assign(value: T?)

Assign value: T to a property with assign operator

fun <T : Any> Property<T>.assign(value: Provider<out T>)

Assign value: Provider to a property with assign operator

convention
Link copied to clipboard
abstract fun convention(value: @Nullable T): Property<T>
disallowChanges
Link copied to clipboard
abstract fun disallowChanges()
disallowUnsafeRead
Link copied to clipboard
abstract fun disallowUnsafeRead()
fileProvider
Link copied to clipboard
abstract fun fileProvider(provider: Provider<File>): FileSystemLocationProperty<T>
Sets the location of this file, using a File Provider instance.
fileValue
Link copied to clipboard
abstract fun fileValue(@Nullable file: @Nullable File): FileSystemLocationProperty<T>
Sets the location of this file, using a File instance.
filter
Link copied to clipboard
abstract fun filter(spec: Spec<in T>): Provider<T>
finalizeValue
Link copied to clipboard
abstract fun finalizeValue()
finalizeValueOnRead
Link copied to clipboard
abstract fun finalizeValueOnRead()
flatMap
Link copied to clipboard
abstract fun <S> flatMap(transformer: Transformer<out @Nullable Provider<out S>, in T>): Provider<S>
get
Link copied to clipboard
abstract fun get(): T
getAsFile
Link copied to clipboard
abstract fun getAsFile(): Provider<File>
Views the location of this file as a File.
getLocationOnly
Link copied to clipboard
abstract fun getLocationOnly(): Provider<T>
Returns the location of the file system element, and discards details of the task that produces its content.
getOrElse
Link copied to clipboard
abstract fun getOrElse(defaultValue: T): T
getOrNull
Link copied to clipboard
abstract fun getOrNull(): @Nullable T
getValue
Link copied to clipboard
operator fun <T : Any> Property<T>.getValue(receiver: Any?, property: KProperty<*>): T

Property delegate for Property instances.

isPresent
Link copied to clipboard
abstract fun isPresent(): Boolean
map
Link copied to clipboard
abstract fun <S> map(transformer: Transformer<out @Nullable S, in T>): Provider<S>
orElse
Link copied to clipboard
abstract fun orElse(value: T): Provider<T>
set
Link copied to clipboard
abstract fun set(@Nullable file: @Nullable File)
Sets the location of this file, using a File instance.
abstract fun set(value: @Nullable T)
setValue
Link copied to clipboard
operator fun <T : Any> Property<T>.setValue(receiver: Any?, property: KProperty<*>, value: T)

Property delegate for Property instances.

unset
Link copied to clipboard
abstract fun unset(): Property<T>
abstract fun unset(): SupportsConvention
unsetConvention
Link copied to clipboard
abstract fun unsetConvention(): Property<T>
abstract fun unsetConvention(): SupportsConvention
value
Link copied to clipboard
abstract fun value(value: @Nullable T): Property<T>
zip
Link copied to clipboard
abstract fun <U, R> zip(right: Provider<U>, combiner: BiFunction<in T, in U, out @Nullable R>): Provider<R>