alchemist/it.unibo.alchemist.model.observables/ObservableMutableList

ObservableMutableList

class ObservableMutableList<T> @JvmOverloads constructor(initial: Iterable<T> = emptyList()) : AbstractObservable<List<T>> , ObservableList<T>

A mutable observable list implementation, which allows for observing changes to the list and provides notifications when its contents are modified. This class supports addition, removal, updates, and observation of modifications to the list.

Parameters

initial

The elements this list initially contains.

Type Parameters

The type of elements maintained by this list.

Constructors

ObservableMutableList

@JvmOverloads

constructor(initial: Iterable<T> = emptyList())

Types

Companion

object Companion

A companion object for the ObservableMutableList class, providing handy factories.

Properties

current

open override val current: List<T>

The current value: while observed, the latest value published; otherwise, a freshly computed one. Observables holding their own state may read it directly.

isObserved

open val isObserved: Boolean

Whether any callback is currently registered.

observerCount

override val observerCount: Int

How many callbacks are currently registered.

size

open override val size: Observable<Int>

Emits the list size whenever it changes.

Functions

add

fun add(item: T): Boolean

Adds an item to the observable list. Observers of the list will be notified of the change.

fun add(index: Int, item: T)

Adds an item at the specified index. Observers of the list will be notified of the change.

addAll

fun addAll(items: Collection<T>): Boolean

Appends all of the elements in the specified collection to the end of this list.

clear

fun clear()

Removes all of the elements from this list.

combineLatest

fun <T, R, O> ObservableList<T>.combineLatest(transformer: (T) -> Observable<R>, aggregator: (List<R>) -> O): Observable<O>

Combines the content of an ObservableList into a single observable by applying a mapping function to each element and aggregating the results.

currentOrNull

fun <T> Observable<Option<T>>.currentOrNull(): T?

Retrieves the current value of the observable if present, or null if no value is available.

dispose

open override fun dispose()

Unregisters every callback registered with this observable.

flatMap

fun <T, O> ObservableList<T>.flatMap(transformer: (T) -> Observable<O>): Observable<Option<O>>

Transforms an ObservableList of type T into a single Observable of type arrow.core.Option<O> by fusing the individual observables obtained from each item in the list.

flattenMerge

fun <T> ObservableList<out Observable<T>>.flattenMerge(): Observable<Option<T>>

Converts this ObservableList of observables into a unique observable.

map

open override fun <S> map(transform: (List<T>) -> S): Observable<S>

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

mergeWith

open override fun <O, R> mergeWith(other: Observable<O>, merge: (List<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

open override fun onChange(notifyOnRegistration: Boolean = true, callback: (List<T>) -> Unit): Disposable

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

remove

fun remove(item: T): Boolean

Removes the first occurrence of the specified item from the observable list, if it is present. If the list changes, observers will be notified.

removeAll

fun removeAll(predicate: (T) -> Boolean): Boolean

Removes all the elements satisfying predicate from the observable list. If the list changes, observers will be notified once.

removeAt

fun removeAt(index: Int): T

Removes the element at the specified position in this list.

set

operator fun set(index: Int, element: T): T

Replaces the element at the specified position in this list with the specified element.

switchMap

@JvmStatic

fun <T, R> Observable<T>.switchMap(transform: (T) -> Observable<R>): Observable<R>

Maps the current value of this Observable to an inner observable through transform, and mirrors the inner observable of the most recent value only: whenever this observable emits, the previous inner observable is unsubscribed and the new one is followed.