architecture/com.splendo.kaluga.architecture.observable/AbstractBaseDefaultSubject

AbstractBaseDefaultSubject

abstract class AbstractBaseDefaultSubject<R : T?, T>(observation: ObservationDefault<R, T?>) : BaseSubject<R, T?, ObservableOptional.Value<R>> , DefaultSubject<R, T> , MutableDefaultInitialized<R, T?>

An abstract class extending BaseSubject that implements DefaultSubject.

Parameters

T

the type of value to expect.

R

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

observation

The ObservationDefault to handle value being observed

Inheritors

BaseDefaultSubject

Constructors

AbstractBaseDefaultSubject

constructor(defaultValue: ObservableOptional.Value<R>, initialValue: ObservableOptional.Value<T?>)

constructor(observation: ObservationDefault<R, T?>)

Properties

open override val current: R

The current value of R

open override val currentOrNull: T?

The current value T or null being observed

open override val defaultValue: ObservableOptional.Value<R>

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

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

The initial ObservableOptional value of T.

liveDataObserver

val <R : T, T, OO : ObservableOptional<R>> BasicSubject<R, T, OO>.liveDataObserver: Observer<T>

The Observer that observes the observable value.

open override val stateFlow: MutableStateFlow<R>

StateFlow that expresses the content from the observable.

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

A ReadOnlyProperty of T

Functions

expect override fun bind(coroutineScope: CoroutineScope, context: CoroutineContext)

Bind changes in value to a CoroutineScope in a CoroutineContext

fun <R : T, T, OO : ObservableOptional<R>> BasicSubject<R, T, OO>.bind(coroutineScope: CoroutineScope)

Convenience method for BasicSubject that calls BasicSubject.bind using the CoroutineContext of the provided CoroutineScope

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

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.

abstract fun post(newValue: T?)

Updates the value of this Postable

abstract suspend fun set(newValue: T?)

Updates the value of this Postable in a suspended manner.

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