alchemist-api/it.unibo.alchemist.model.observation/MutableObservable

MutableObservable

interface MutableObservable<T> : Observable<T> (source)

A MutableObservable represents an extension of the Observable interface, designed to maintain mutable state and notify its observers when the state changes. Updates are mainly performed thanks to the update function.

Type Parameters

The type of the value being observed and modified.

Properties

current

abstract override var current: T

The current state or value of the observable.

isObserved

open val isObserved: Boolean

Whether any callback is currently registered.

observerCount

abstract val observerCount: Int

How many callbacks are currently registered.

Functions

dispose

abstract override fun dispose()

Unregisters every callback registered with this observable.

map

abstract fun <S> map(transform: (T) -> S): Observable<S>

Transforms the current observable into a new observable by applying the specified transformation function to its emitted values.

mergeWith

abstract fun <O, R> mergeWith(other: Observable<O>, merge: (T, O) -> R): Observable<R>

Combines the current observable with another observable, producing a new observable that emits values derived by applying the provided merge function to the current values of both observables.

onChange

abstract fun onChange(notifyOnRegistration: Boolean = true, callback: (T) -> Unit): Disposable

Registers callback to be invoked with every new value of this observable, and right away with the current one if notifyOnRegistration.

update

open fun update(computeNewValue: (T) -> T): T

Updates the current value using the specified transformation function and returns the previous value.