gradle/org.gradle.api.provider/Property

Property

interface Property<T> : Provider<T> , HasConfigurableValue, SupportsConvention(source)

A container object that represents a configurable value of a specific type. A Property is also a Provider and can be used in the same way as a Provider. A property's value can be accessed using the methods of Provider such as get(). The value can be modified by using the methods set and set, or their fluid API counterparts value and value.

A property may represent a task output. Such a property carries information about the task producing its value. When this property is attached to an input of another task, Gradle will automatically determine the task dependencies based on this connection.

You can create a Property instance using property. There are also several specialized subtypes of this interface that can be created using various other factory methods.

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

Since

4.3

Inheritors

FileSystemLocationProperty

Functions

assign

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: T): Property<T>

Specifies the value to use as the convention (default value) for this property.

abstract fun convention(provider: Provider<out T>): Property<T>

Specifies the provider to be used to query the convention (default value) for this property.

disallowChanges

abstract fun disallowChanges()

disallowUnsafeRead

abstract fun disallowUnsafeRead()

filter

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

finalizeValue

abstract fun finalizeValue()

Disallows further changes to the value of this property.

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

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(@Nullable value: T)

Sets the value of the property to the given value, replacing whatever value the property already had.

abstract fun set(provider: Provider<out T>)

Sets the property to have the same value as the given provider, replacing whatever value the property already had.

setValue

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

Property delegate for Property instances.

unset

abstract fun unset(): Property<T>

This is similar to calling value with a null argument.

unsetConvention

abstract fun unsetConvention(): Property<T>

This is similar to calling convention with a null argument.

value

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

Sets the value of the property to the given value, replacing whatever value the property already had.

abstract fun value(provider: Provider<out T>): Property<T>

Sets the property to have the same value as the given provider, replacing whatever value the property already had.

zip

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