watchable/io.gladed.watchable/WatchableList

WatchableList

A Watchable which may also be modified or bound. Use watchableListOf to create.

interface WatchableList<T> : MutableWatchable<MutableList<T>, ListChange<T>> , ReadOnlyWatchableList<T>

Functions

add

Add element to the end of this list, returning true if the list changed.

open suspend fun add(element: T): Boolean

addAll

Add elements to the end of this list, returning true if the list changed.

open suspend fun addAll(elements: Array<T>): Boolean

open suspend fun addAll(elements: Iterable<T>): Boolean

open suspend fun addAll(elements: Sequence<T>): Boolean

batch

abstract override fun batch(scope: CoroutineScope, period: Long, func: SuspendFunction1<List<ListChange<T>>, Unit>): Watcher

bind

Binds this unbound object to origin, such that when origin changes, this object is updated to match origin exactly, until scope completes. While bound, this object may not be externally modified or rebound.

abstract override fun bind(scope: CoroutineScope, origin: Watchable<ListChange<T>>): Watcher

Binds this unbound object to origin, such that for every change to origin, the change is applied to this object with apply, until scope completes. While bound, this object may not be externally modified or rebound.

abstract override fun <C2 : Change> bind(scope: CoroutineScope, origin: Watchable<C2>, period: Long, apply: MutableList<T>.(C2) -> Unit): Watcher

clear

Remove all items.

abstract suspend override fun clear()

contains

abstract operator override fun contains(element: T): Boolean

containsAll

abstract override fun containsAll(elements: Collection<T>): Boolean

equals

open operator override fun equals(other: Any?): Boolean

forEach

open override fun forEach(p0: Consumer<in T>)

get

abstract operator override fun get(index: Int): T

hashCode

open override fun hashCode(): Int

indexOf

abstract override fun indexOf(element: T): Int

invoke

Suspend until func can safely execute on the mutable form M of this watchable, returning func's result. func must not block or return the mutable form outside of this routine.

abstract suspend operator override fun <U> invoke(func: MutableList<T>.() -> U): U

isBound

Return true if this object is already bound.

open override fun isBound(): Boolean

isEmpty

abstract override fun isEmpty(): Boolean

iterator

abstract operator override fun iterator(): Iterator<T>

lastIndexOf

abstract override fun lastIndexOf(element: T): Int

listIterator

abstract override fun listIterator(): ListIterator<T>

abstract override fun listIterator(index: Int): ListIterator<T>

minusAssign

Remove element from this list.

open suspend operator fun minusAssign(element: T)

Remove elements from this list.

open suspend operator fun minusAssign(elements: Array<T>)

open suspend operator fun minusAssign(elements: Iterable<T>)

open suspend operator fun minusAssign(elements: Sequence<T>)

parallelStream

open override fun parallelStream(): Stream<T>

plusAssign

Add element to the end of this list.

open suspend operator fun plusAssign(element: T)

Add elements to the end of this list.

open suspend operator fun plusAssign(elements: Array<T>)

open suspend operator fun plusAssign(elements: Iterable<T>)

open suspend operator fun plusAssign(elements: Sequence<T>)

readOnly

Return an unmodifiable form of this WatchableList.

abstract override fun readOnly(): ReadOnlyWatchableList<T>

remove

Remove element from this list, returning true if the list changed.

open suspend fun remove(element: T): Boolean

removeAll

Remove elements from this list, returning true if the list changed.

open suspend fun removeAll(elements: Array<T>): Boolean

open suspend fun removeAll(elements: Iterable<T>): Boolean

open suspend fun removeAll(elements: Sequence<T>): Boolean

retainAll

Retain only the elements in this list that are found in elements, returning true if the list changed.

open suspend fun retainAll(elements: Iterable<T>): Boolean

simple

Deliver simplified changes to func until scope completes.

open override fun simple(scope: CoroutineScope, period: Long, func: SuspendFunction1<ListChange.Simple<T>, Unit>): Watcher

spliterator

open override fun spliterator(): Spliterator<T>

stream

open override fun stream(): Stream<T>

subList

abstract override fun subList(fromIndex: Int, toIndex: Int): List<T>

toString

open override fun toString(): String

twoWayBind

Bind other to this so that any change in either object is reflected in the other.

abstract override fun twoWayBind(scope: CoroutineScope, other: MutableWatchable<MutableList<T>, ListChange<T>>): Watcher

abstract override fun <M2, C2 : Change> twoWayBind(scope: CoroutineScope, other: MutableWatchable<M2, C2>, update: MutableList<T>.(C2) -> Unit, updateOther: M2.(ListChange<T>) -> Unit): Watcher

unbind

Remove any existing binding for this object.

abstract override fun unbind()

waitFor

open suspend override fun waitFor(scope: CoroutineScope, func: () -> Boolean)

watch

open override fun watch(scope: CoroutineScope, period: Long, func: SuspendFunction1<ListChange<T>, Unit>): Watcher

Properties

boundTo

The Watchable to which this object is bound, if any.

abstract override val boundTo: Watchable<*>?

size

abstract override val size: Int