runtime-core/aws.smithy.kotlin.runtime.collections/MutableMultiMap

MutableMultiMap

interface MutableMultiMap<K, V> : MutableMap<K, MutableList<V>>

A mutable collection similar to a MutableMap except it allows multiple values to be associated with a single key. The associated values are not necessarily distinct (e.g., key foo may be associated with value bar multiple times).

Parameters

The type of elements used as keys

The type of elements used as values

Inheritors

Builder

Properties

entryValues

abstract val entryValues: Sequence<Map.Entry<K, V>>

Gets a Sequence of key-value pairs. A given key will appear multiple times in the sequence if it is associated with multiple values. This sequence lazily enumerates over keys and values in the multimap and may reflect changes which occurred after the iteration began.

Inherited properties

entries

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

keys

abstract override val keys: MutableSet<K>

size

abstract val size: Int

values

abstract override val values: MutableCollection<MutableList<V>>

Functions

add

abstract fun add(key: K, value: V): Boolean

Adds an association from the given key to the given value

abstract fun add(key: K, index: Int, value: V)

Adds an association from the given key to the given value, inserting it at the given index in the list of values already associated with the key.

addAll

open fun addAll(other: Map<K, List<V>>)

Adds all the key-value associations from another map into this one. This will append to the existing associations, not merge or deduplicate. This operation copies from the given values lists. Later changes to those lists do not affect this collection.

abstract fun addAll(key: K, values: Collection<V>): Boolean

Adds associations from the given key to the given values. This will append to the existing associations, not merge or deduplicate. This operation copies from the given values. Later changes to the collection do not affect this instance.

abstract fun addAll(key: K, index: Int, values: Collection<V>): Boolean

Adds associations from the given key to the given values, inserting them at the given index in the list of values already associated with the key. This operation copies from the given values. Later changes to the collection do not affect this instance.

contains