architecture/com.splendo.kaluga.architecture.observable/ReadOnlyPropertyInitializedObservable

ReadOnlyPropertyInitializedObservable

class ReadOnlyPropertyInitializedObservable<T>(readOnlyProperty: ReadOnlyProperty<Any?, T>, observation: ObservationInitialized<T> = ObservationInitialized( ObservableOptional.Value( run { val v by readOnlyProperty v }, ), )) : BaseInitializedObservable<T> , InitializedObservable<T>

A BaseInitializedObservable that matches its value to a ReadOnlyProperty. When the ReadOnlyProperty updates, changes to the property are not immediately delegated back to the observable. Use a Flow based observable if synchronized values are required.

Parameters

the type of value to expect.

readOnlyProperty

The ReadOnlyProperty to track.

observation

The ObservationInitialized to handle observation.

Constructors

ReadOnlyPropertyInitializedObservable

constructor(readOnlyProperty: ReadOnlyProperty<Any?, T>, observation: ObservationInitialized<T> = ObservationInitialized( ObservableOptional.Value( run { val v by readOnlyProperty v }, ), ))

Properties

current

open override val current: T

The current value of R

currentOrNull

open override val currentOrNull: T?

The current value T or null being observed

initialValue

open override val initialValue: ObservableOptional.Value<T>

The initial ObservableOptional value of T.

stateFlow

expect open override val stateFlow: StateFlow<T>

StateFlow that expresses the content from the observable.

valueDelegate

expect open override val valueDelegate: ReadOnlyProperty<Any?, T>

A ReadOnlyProperty of T

Functions

getValue

open operator override fun getValue(thisRef: Any?, property: KProperty<*>): ObservableOptional.Value<T>

observe

open override fun observe(onNext: (T?) -> Unit): Disposable

Creates an observation that calls onNext each time a new value is observed until the resulting Disposable is disposed

observeInitialized

open override fun observeInitialized(onNext: (T) -> Unit): Disposable

observeNotNullOnLifecycle

fun <T> WithState<T?>.observeNotNullOnLifecycle(lifecycleOwner: LifecycleOwner, filter: suspend (T) -> Boolean = { true }, onNext: (T) -> Unit): Job

Observes WithState of a nullable value on the lifecycle of a LifecycleOwner

observeOnLifecycle

fun <T> WithState<T>.observeOnLifecycle(lifecycleOwner: LifecycleOwner, filter: suspend (T) -> Boolean = { true }, onNext: (T) -> Unit): Job

Observes WithState on the lifecycle of a LifecycleOwner

fun <T, R> WithState<T>.observeOnLifecycle(lifecycleOwner: LifecycleOwner, filter: suspend (T) -> Boolean = { true }, transform: suspend (T) -> R, onNext: (R) -> Unit): Job

Observes WithState on the lifecycle of a LifecycleOwner by transforming the observed value.

toDefaultObservable

fun <R : T, T> ReadOnlyProperty<Any?, T?>.toDefaultObservable(defaultValue: R): ReadOnlyPropertyDefaultObservable<R, T?>

Converts a ReadOnlyProperty into a ReadOnlyPropertyDefaultObservable

toInitializedObservable

fun <T> ReadOnlyProperty<Any?, T>.toInitializedObservable(): ReadOnlyPropertyInitializedObservable<T>

Converts a ReadOnlyProperty into a ReadOnlyPropertyInitializedObservable