kotter/com.varabyte.kotter.foundation.collections/LiveMap

LiveMap

@ThreadSafe

Like LiveVar, but for maps.

In other words, adding or removing to the map will cause the active section to rerender automatically.

For example:

val num2Names = liveMapOf(1 to "one", 2 to "two", 3 to "three")
section {
    num2Names.forEach { (num, name) -> textLine("$num is spelled \"$name\"") }
}.run {
    num2Names.putAll(mapOf(4 to "four", 5 to "five", 6 to "six"))
}

This class is thread safe and expected to be accessed across different threads.

Properties

entries

open override val entries: MutableSet<MutableMap.MutableEntry<K, V>>

keys

open override val keys: MutableSet<K>

size

open override val size: Int

values

open override val values: MutableCollection<V>

Functions

clear

open override fun clear()

containsKey

open override fun containsKey(key: K): Boolean

containsValue

open override fun containsValue(value: V): Boolean

get

open operator override fun get(key: K): V?

isEmpty

open override fun isEmpty(): Boolean

put

open override fun put(key: K, value: V): V?

putAll

open override fun putAll(from: Map<out K, V>)

remove

open override fun remove(key: K): V?

withReadLock

fun <R> withReadLock(block: LiveMap<K, V>.() -> R): R

Allow calls to lock the map for a longer time than just a single field at a time, useful if reading many fields at once.

withWriteLock

fun <R> withWriteLock(block: LiveMap<K, V>.() -> R): R

Allow calls to write lock the map for a longer time than just a single field at a time, useful if updating many fields at once.