commons-provider-dsl/xyz.xenondevs.commons.provider.dsl/ProviderDslProperty

ProviderDslProperty

@SubclassOptInRequired(markerClass = [UnstableProviderApi::class])

interface ProviderDslProperty<T> : DslProperty<T> , Provider<T>

A DSL property backed by a Provider. Can be set to a static value or bound to a reactive Provider using the by infix function.

// static value
stringValue by "abc"

// reactive provider
stringValue by myStringProvider

This property is also a Provider, meaning that the configured provider can be read back:

val mapped = stringValue.map { it.length }
intValue by mapped

Properties

children

abstract val children: Set<Provider<*>>

delegate

open val delegate: Provider<T>

isStable

abstract val isStable: Boolean

parents

abstract val parents: Set<Provider<*>>

value

abstract val value: DeferredValue<T>

Functions

addStrongChild

abstract fun addStrongChild(child: Provider<*>)

addWeakChild

abstract fun addWeakChild(child: Provider<*>)

open infix fun by(value: T)

Sets this property to a static value.

abstract infix fun by(provider: Provider<T>)

Binds this property to a reactive Provider. The property will update automatically when the provider's value changes.

@JvmName(name = "listByValue")

infix fun <T : Any> DslProperty<in List<T>>.by(value: T)

Sets this List property to a single value.

@JvmName(name = "listByValueProvider")

infix fun <T : Any> DslProperty<in List<T>>.by(value: Provider<T>)

Sets this List property to a provider of a single value.

@JvmName(name = "setByValue")

infix fun <T : Any> DslProperty<in Set<T>>.by(value: T)

Sets this Set property to a single value.

@JvmName(name = "setByValueProvider")

infix fun <T : Any> DslProperty<in Set<T>>.by(value: Provider<T>)

Sets this Set property to a provider of a single value.

flatMap

abstract fun <R> flatMap(transform: (T) -> Provider<R>): Provider<R>

get

open override fun get(): T

getValue

open operator fun <X> getValue(thisRef: X?, property: KProperty<*>?): T

handleParentUpdated

abstract fun handleParentUpdated(updatedParent: Provider<*>)

immediateFlatMap

abstract fun <R> immediateFlatMap(transform: (T) -> Provider<R>): Provider<R>

immediateFlatMapMutable

abstract fun <R> immediateFlatMapMutable(transform: (T) -> MutableProvider<R>): MutableProvider<R>

map

abstract fun <R> map(transform: (T) -> R): Provider<R>

observe

abstract fun observe(action: () -> Unit)

observeWeak

abstract fun <R : Any> observeWeak(owner: R, action: (owner: R) -> Unit)

removeStrongChild

abstract fun removeStrongChild(child: Provider<*>)

removeWeakChild

abstract fun removeWeakChild(child: Provider<*>)

strongFlatMap

abstract fun <R> strongFlatMap(transform: (T) -> Provider<R>): Provider<R>

strongImmediateFlatMap

abstract fun <R> strongImmediateFlatMap(transform: (T) -> Provider<R>): Provider<R>

strongImmediateFlatMapMutable

abstract fun <R> strongImmediateFlatMapMutable(transform: (T) -> MutableProvider<R>): MutableProvider<R>

strongMap

abstract fun <R> strongMap(transform: (T) -> R): Provider<R>

abstract fun subscribe(action: (value: T) -> Unit)

subscribeWeak

abstract fun <R : Any> subscribeWeak(owner: R, action: (owner: R, value: T) -> Unit)

unobserve

abstract fun unobserve(action: () -> Unit)

unobserveWeak

abstract fun <R : Any> unobserveWeak(owner: R)

abstract fun <R : Any> unobserveWeak(owner: R, action: (R) -> Unit)

unsubscribe

abstract fun unsubscribe(action: (T) -> Unit)

unsubscribeWeak

abstract fun <R : Any> unsubscribeWeak(owner: R)

abstract fun <R : Any> unsubscribeWeak(owner: R, action: (R, T) -> Unit)