alchemist-implementationbase/it.unibo.alchemist.model.observables/ObservableMutableSet

ObservableMutableSet

class ObservableMutableSet<T>(initial: Iterable<T> = emptyList()) : AbstractObservable<Set<T>> , ObservableSet<T> (source)

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

Type Parameters

The type of elements maintained by this set.

Constructors

ObservableMutableSet

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

Types

Companion

object Companion

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

Properties

current

open override val current: Set<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

observerCount

override val observerCount: Int

size

open override val size: Observable<Int>

Functions

add

fun add(item: T)

Adds an item to the observable set. If the item does not already exist in the set, it will be added, and observers of the set will be notified of the change.

clearAndAddAll

fun clearAndAddAll(items: Set<T>)

Replaces the contents of this set with items. The observers of the set are notified once, if the contents change, and the observers of an item only if the presence of that item changes.

combineLatest

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

Combines the content of an ObservableSet into a single observable by applying a mapping function to each element and aggregating the results. This function generates a single observable that emits every time the underlying set of contents is changed, or some of the values (which are in turn observables) emit a changes, triggering the re-evaluation of the aggregation function.

containsItem

open override fun containsItem(item: T): Observable<Boolean>

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()

flatMap

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

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

flattenMerge

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

Converts this ObservableSet of observables into a unique observable that emits when either this set would have changed (addition/removal of members) or one of its members emits a value.

map

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

mergeWith

open override fun <O, R> mergeWith(other: Observable<O>, merge: (Set<T>, O) -> R): Observable<R>

onChange

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

remove

fun remove(item: T): Boolean

Removes the specified item from the observable set. If the item exists in the set, it will be removed, and observers of the set will be notified of the change.

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.

union

infix fun <T> ObservableSet<T>.union(other: ObservableSet<T>): ObservableSet<T>

Combines this observable set with another, producing a new observable set that represents the union of both sets.