architecture/com.splendo.kaluga.architecture.observable/Observation

Observation

open class ~~Observation~~<R : T, T, OO : ObservableOptional<R>>(val initialValue: ObservableOptional<T>) : Initial<R, T>

Deprecated

This feature has been deprecated. It is recommended to use Compose Multiplatform instead.

Class that handles observing value changes for a value of a given type

Parameters

initialValue

The initial value this observation should contain.

Type Parameters

T

the type of value to expect.

R

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

OO

the type of ObservableOptional to store the result in.

Inheritors

ObservationInitialized

ObservationUninitialized

ObservationDefault

Constructors

constructor(initialValue: ObservableOptional<T>)

Properties

beforeObservedValueGet

var beforeObservedValueGet: (OO) -> ObservableOptional<T>?

Transformation to apply to the latest value when observedValue is called.

currentObserved

val currentObserved: OO

The currently observed OO

open override val currentOrNull: R?

The current value T or null being observed

open val defaultValue: ObservableOptional.Value<R>? = null

The default ObservableOptional.Value to return if the current value is ObservableOptional.Nothing or ObservableOptional.Value containing null.

open override val initialValue: ObservableOptional<T>

var observedValue: ObservableOptional<T>

The ObservableOptional or T that is currently being observed.

onFirstObservation

var onFirstObservation: () -> Unit?

Action to execute when this observable is observed for the first time.

Functions

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

Adds an observing function to the Observable to be notified on each change to the observable. If there is a current value, there will be an immediate notification

suspend fun setValue(value: ObservableOptional<T>): ObservableOptional<T>

set the value of this Observable from a suspended context.