gradle
8.5

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

## 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> 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
Link copied to clipboard
abstract fun convention(@Nullable value: RegularFile): RegularFileProperty
abstract fun convention(provider: Provider<out RegularFile>): RegularFileProperty
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>): RegularFileProperty
fileValue
Link copied to clipboard
abstract fun fileValue(@Nullable file: File): RegularFileProperty
filter
Link copied to clipboard
abstract fun filter(spec: Spec<out Any>): 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>, out Any>): Provider<S>
forUseAtConfigurationTime
Link copied to clipboard
abstract fun forUseAtConfigurationTime(): Provider<T>
get
Link copied to clipboard
abstract fun get(): T
getAsFile
Link copied to clipboard
abstract fun getAsFile(): Provider<File>
getLocationOnly
Link copied to clipboard
abstract fun getLocationOnly(): Provider<T>
getOrElse
Link copied to clipboard
abstract fun getOrElse(defaultValue: T): T
getOrNull
Link copied to clipboard
abstract fun getOrNull(): T
getValue
Link copied to clipboard
operator fun <T> 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, out Any>): Provider<S>
orElse
Link copied to clipboard
abstract fun orElse(value: T): Provider<T>
set
Link copied to clipboard
abstract fun set(file: File)
setValue
Link copied to clipboard
operator fun <T> Property<T>.setValue(receiver: Any?, property: KProperty<*>, value: T)

Property delegate for Property instances.

value
Link copied to clipboard
abstract fun value(@Nullable value: RegularFile): RegularFileProperty
abstract fun value(provider: Provider<out RegularFile>): RegularFileProperty
zip
Link copied to clipboard
abstract fun <U, R> zip(right: Provider<U>, combiner: BiFunction<out Any, out Any, out @Nullable R>): Provider<R>