architecture/com.splendo.kaluga.architecture.observable/ReadOnlyPropertyDefaultObservable

ReadOnlyPropertyDefaultObservable

class ReadOnlyPropertyDefaultObservable<R : T?, T>(defaultValue: R, readOnlyProperty: ReadOnlyProperty<Any?, T>, observation: ObservationDefault<R, T?> = ObservationDefault( defaultValue, ObservableOptional.Value( run { val v by readOnlyProperty v }, ), )) : BaseDefaultObservable<R, T>

A BaseDefaultObservable 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

defaultValue

The default R to return if the value of the ReadOnlyProperty is null.

readOnlyProperty

The ReadOnlyProperty to track.

observation

The ObservationInitialized to handle observation.

Type Parameters

the type of value to expect.

the type of result to expect. Must be a subclass of T

Constructors

ReadOnlyPropertyDefaultObservable

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

Properties

current

open override val current: R

The current value of R

currentOrNull

open override val currentOrNull: T?

The current value T or null being observed

defaultValue

open override val defaultValue: ObservableOptional.Value<R>

The default Value of R. Can be used in case Nothing is Initial.initialValue

initialValue

open override val initialValue: ObservableOptional.Value<T?>

The initial ObservableOptional value of T.

stateFlow

open override val stateFlow: StateFlow<R>

StateFlow that expresses the content from the observable.

valueDelegate

open override val valueDelegate: ReadOnlyProperty<Any?, R>

A ReadOnlyProperty of T

Functions

getValue

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

observe

open override fun observe(onNext: (R?) -> 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: (R) -> 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