gradle/org.gradle.api.file/RegularFileProperty

RegularFileProperty

interface RegularFileProperty : FileSystemLocationProperty<T> (source)

Represents some configurable regular file location, whose value is mutable.

You can create a RegularFileProperty using fileProperty.

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

Since

4.3

Functions

assign

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

convention

abstract fun convention(@Nullable value: RegularFile): RegularFileProperty

abstract fun convention(provider: Provider<out RegularFile>): RegularFileProperty

disallowChanges

abstract fun disallowChanges()

disallowUnsafeRead

abstract fun disallowUnsafeRead()

fileProvider

abstract fun fileProvider(provider: Provider<File>): RegularFileProperty

fileValue

abstract fun fileValue(@Nullable file: File): RegularFileProperty

filter

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

finalizeValue

abstract fun finalizeValue()

finalizeValueOnRead

abstract fun finalizeValueOnRead()

flatMap

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

forUseAtConfigurationTime

abstract fun forUseAtConfigurationTime(): Provider<T>

get

abstract fun get(): T

getAsFile

abstract fun getAsFile(): Provider<File>

getLocationOnly

abstract fun getLocationOnly(): Provider<T>

getOrElse

abstract fun getOrElse(defaultValue: T): T

getOrNull

abstract fun getOrNull(): T

getValue

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

Property delegate for Property instances.

isPresent

abstract fun isPresent(): Boolean

map

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

orElse

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

set

abstract fun set(file: File)

setValue

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

Property delegate for Property instances.

unset

abstract fun unset(): Property<T>

abstract fun unset(): SupportsConvention

unsetConvention

abstract fun unsetConvention(): Property<T>

abstract fun unsetConvention(): SupportsConvention

value

abstract fun value(@Nullable value: RegularFile): RegularFileProperty

abstract fun value(provider: Provider<out RegularFile>): RegularFileProperty

zip

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