gradle/org.gradle.api.file/FileSystemLocationProperty

FileSystemLocationProperty

interface FileSystemLocationProperty<T : FileSystemLocation?> : Property<T> (source)

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

RegularFileProperty

DirectoryProperty

Functions

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> Property<T>.assign(value: T?)

Assign value: T to a property with assign operator

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

Assign value: Provider to a property with assign operator

abstract fun convention(value: T): Property<T>

disallowChanges

abstract fun disallowChanges()

disallowUnsafeRead

abstract fun disallowUnsafeRead()

abstract fun fileProvider(provider: Provider<File>): FileSystemLocationProperty<T>

Sets the location of this file, using a File Provider instance.

abstract fun fileValue(@Nullable file: File): FileSystemLocationProperty<T>

Sets the location of this file, using a File instance.

abstract fun filter(spec: Spec<in T>): Provider<T>

abstract fun finalizeValue()

finalizeValueOnRead

abstract fun finalizeValueOnRead()

abstract fun <S> flatMap(transformer: Transformer<out @Nullable Provider<out S>, in T>): Provider<S>

forUseAtConfigurationTime

abstract fun forUseAtConfigurationTime(): Provider<T>

abstract fun get(): T

abstract fun getAsFile(): Provider<File>

Views the location of this file as a File.

getLocationOnly

abstract fun getLocationOnly(): Provider<T>

Returns the location of the file system element, and discards details of the task that produces its content.

abstract fun getOrElse(defaultValue: T): T

abstract fun getOrNull(): T

operator fun <T> Property<T>.getValue(receiver: Any?, property: KProperty<*>): T

Property delegate for Property instances.

abstract fun isPresent(): Boolean

abstract fun <S> map(transformer: Transformer<out @Nullable S, in T>): Provider<S>

abstract fun orElse(value: T): Provider<T>

abstract fun set(@Nullable file: File)

Sets the location of this file, using a File instance.

abstract fun set(value: T)

operator fun <T> Property<T>.setValue(receiver: Any?, property: KProperty<*>, value: T)

Property delegate for Property instances.

abstract fun unset(): Property<T>

abstract fun unset(): SupportsConvention

unsetConvention

abstract fun unsetConvention(): Property<T>

abstract fun unsetConvention(): SupportsConvention

abstract fun value(value: T): Property<T>

abstract fun <U, R> zip(right: Provider<U>, combiner: BiFunction<in T, in U, out @Nullable R>): Provider<R>