Map

clear

abstract fun clear(): Unit

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

compute

open fun compute(
    key: K, 
    remappingFunction: BiFunction<in K, in V?, out V?>
): V?

Attempts to compute a mapping for the specified key and its current mapped value (or null if there is no current mapping). For example, to either create or append a String msg to a value mapping:

<code>map.compute(key, (k, v) -&gt; (v == null) ? msg : v.concat(msg))</code>

If the remapping function returns null, the mapping is removed (or remains absent if initially absent). If the remapping function itself throws an (unchecked) exception, the exception is rethrown, and the current mapping is left unchanged.

The remapping function should not modify this map during computation.

computeIfAbsent

open fun computeIfAbsent(
    key: K, 
    mappingFunction: Function<in K, out V>
): V

If the specified key is not already associated with a value (or is mapped to null), attempts to compute its value using the given mapping function and enters it into this map unless null.

If the mapping function returns null, no mapping is recorded. If the mapping function itself throws an (unchecked) exception, the exception is rethrown, and no mapping is recorded. The most common usage is to construct a new object serving as an initial mapped value or memoized result, as in:

<code>map.computeIfAbsent(key, k -&gt; new Value(f(k)));
  </code>

Or to implement a multi-value map, Map<K,Collection<V>>, supporting multiple values per key:

<code>map.computeIfAbsent(key, k -&gt; new HashSet&lt;V&gt;()).add(v);
  </code>

The mapping function should not modify this map during computation.

computeIfPresent

open fun computeIfPresent(
    key: K, 
    remappingFunction: BiFunction<in K, in V, out V?>
): V?

If the value for the specified key is present and non-null, attempts to compute a new mapping given the key and its current mapped value.

If the remapping function returns null, the mapping is removed. If the remapping function itself throws an (unchecked) exception, the exception is rethrown, and the current mapping is left unchanged.

The remapping function should not modify this map during computation.

containsKey

abstract fun containsKey(key: Any?): Boolean

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that Objects.equals(key, k). (There can be at most one such mapping.)

containsValue

abstract fun containsValue(value: Any?): Boolean

Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that Objects.equals(value, v). This operation will probably require time linear in the map size for most implementations of the Map interface.

copyOf

open static fun <K : Any!, V : Any!> copyOf(map: MutableMap<out K, out V>): MutableMap<K, V>

Returns an unmodifiable Map containing the entries of the given Map. The given Map must not be null, and it must not contain any null keys or values. If the given Map is subsequently modified, the returned Map will not reflect such modifications.

entry

open static fun <K : Any!, V : Any!> entry(
    k: K, 
    v: V
): MutableEntry<K, V>

Returns an unmodifiable Entry containing the given key and value. These entries are suitable for populating Map instances using the Map.ofEntries() method. The Entry instances created by this method have the following characteristics:

• They disallow null keys and values. Attempts to create them using a null key or value result in NullPointerException.
• They are unmodifiable. Calls to Entry.setValue() on a returned Entry result in UnsupportedOperationException.
• They are not serializable.
• They are value-based. Programmers should treat instances that are equal as interchangeable and should not use them for synchronization, or unpredictable behavior may occur. For example, in a future release, synchronization may fail. Callers should make no assumptions about the identity of the returned instances. This method is free to create new instances or reuse existing ones.

entrySet

abstract fun entrySet(): MutableSet<MutableEntry<K, V>!>

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

forEach

open fun forEach(action: BiConsumer<in K, in V>): Unit

Performs the given action for each entry in this map until all entries have been processed or the action throws an exception. Unless otherwise specified by the implementing class, actions are performed in the order of entry set iteration (if an iteration order is specified.) Exceptions thrown by the action are relayed to the caller.

get

abstract fun get(key: Any?): V?

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that Objects.equals(key, k), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

getOrDefault

open fun getOrDefault(
    key: Any?, 
    defaultValue: V?
): V?

Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key.

isEmpty

abstract fun isEmpty(): Boolean

Returns true if this map contains no key-value mappings.

keySet

abstract fun keySet(): MutableSet<K>

Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

merge

open fun merge(
    key: K, 
    value: V, 
    remappingFunction: BiFunction<in V, in V, out V?>
): V?

If the specified key is not already associated with a value or is associated with null, associates it with the given non-null value. Otherwise, replaces the associated value with the results of the given remapping function, or removes if the result is null. This method may be of use when combining multiple mapped values for a key. For example, to either create or append a String msg to a value mapping:

<code>map.merge(key, msg, String::concat)
  </code>

If the remapping function returns null, the mapping is removed. If the remapping function itself throws an (unchecked) exception, the exception is rethrown, and the current mapping is left unchanged.

The remapping function should not modify this map during computation.

of

open static fun <K : Any!, V : Any!> of(): MutableMap<K, V>

Returns an unmodifiable map containing zero mappings. See Unmodifiable Maps for details.

of

open static fun <K : Any!, V : Any!> of(
    k1: K, 
    v1: V
): MutableMap<K, V>

Returns an unmodifiable map containing a single mapping. See Unmodifiable Maps for details.

of

open static fun <K : Any!, V : Any!> of(
    k1: K, 
    v1: V, 
    k2: K, 
    v2: V
): MutableMap<K, V>

Returns an unmodifiable map containing two mappings. See Unmodifiable Maps for details.

of

open static fun <K : Any!, V : Any!> of(
    k1: K, 
    v1: V, 
    k2: K, 
    v2: V, 
    k3: K, 
    v3: V
): MutableMap<K, V>

Returns an unmodifiable map containing three mappings. See Unmodifiable Maps for details.

of

open static fun <K : Any!, V : Any!> of(
    k1: K, 
    v1: V, 
    k2: K, 
    v2: V, 
    k3: K, 
    v3: V, 
    k4: K, 
    v4: V
): MutableMap<K, V>

Returns an unmodifiable map containing four mappings. See Unmodifiable Maps for details.

of

open static fun <K : Any!, V : Any!> of(
    k1: K, 
    v1: V, 
    k2: K, 
    v2: V, 
    k3: K, 
    v3: V, 
    k4: K, 
    v4: V, 
    k5: K, 
    v5: V
): MutableMap<K, V>

Returns an unmodifiable map containing five mappings. See Unmodifiable Maps for details.

of

open static fun <K : Any!, V : Any!> of(
    k1: K, 
    v1: V, 
    k2: K, 
    v2: V, 
    k3: K, 
    v3: V, 
    k4: K, 
    v4: V, 
    k5: K, 
    v5: V, 
    k6: K, 
    v6: V
): MutableMap<K, V>

Returns an unmodifiable map containing six mappings. See Unmodifiable Maps for details.

of

open static fun <K : Any!, V : Any!> of(
    k1: K, 
    v1: V, 
    k2: K, 
    v2: V, 
    k3: K, 
    v3: V, 
    k4: K, 
    v4: V, 
    k5: K, 
    v5: V, 
    k6: K, 
    v6: V, 
    k7: K, 
    v7: V
): MutableMap<K, V>

Returns an unmodifiable map containing seven mappings. See Unmodifiable Maps for details.

of

open static fun <K : Any!, V : Any!> of(
    k1: K, 
    v1: V, 
    k2: K, 
    v2: V, 
    k3: K, 
    v3: V, 
    k4: K, 
    v4: V, 
    k5: K, 
    v5: V, 
    k6: K, 
    v6: V, 
    k7: K, 
    v7: V, 
    k8: K, 
    v8: V
): MutableMap<K, V>

Returns an unmodifiable map containing eight mappings. See Unmodifiable Maps for details.

of

open static fun <K : Any!, V : Any!> of(
    k1: K, 
    v1: V, 
    k2: K, 
    v2: V, 
    k3: K, 
    v3: V, 
    k4: K, 
    v4: V, 
    k5: K, 
    v5: V, 
    k6: K, 
    v6: V, 
    k7: K, 
    v7: V, 
    k8: K, 
    v8: V, 
    k9: K, 
    v9: V
): MutableMap<K, V>

Returns an unmodifiable map containing nine mappings. See Unmodifiable Maps for details.

of

open static fun <K : Any!, V : Any!> of(
    k1: K, 
    v1: V, 
    k2: K, 
    v2: V, 
    k3: K, 
    v3: V, 
    k4: K, 
    v4: V, 
    k5: K, 
    v5: V, 
    k6: K, 
    v6: V, 
    k7: K, 
    v7: V, 
    k8: K, 
    v8: V, 
    k9: K, 
    v9: V, 
    k10: K, 
    v10: V
): MutableMap<K, V>

Returns an unmodifiable map containing ten mappings. See Unmodifiable Maps for details.

ofEntries

@SafeVarargs open static fun <K : Any!, V : Any!> ofEntries(vararg entries: MutableEntry<out K, out V>!): MutableMap<K, V>

Returns an unmodifiable map containing keys and values extracted from the given entries. The entries themselves are not stored in the map. See Unmodifiable Maps for details.

put

abstract fun put(
    key: K, 
    value: V
): V?

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

putAll

abstract fun putAll(m: MutableMap<out K, out V>): Unit

Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress. If the specified map has a defined encounter order, processing of its mappings generally occurs in that order.

putIfAbsent

open fun putIfAbsent(
    key: K, 
    value: V
): V?

If the specified key is not already associated with a value (or is mapped to null) associates it with the given value and returns null, else returns the current value.

remove

abstract fun remove(key: Any?): V?

Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that Objects.equals(key, k), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.

The map will not contain a mapping for the specified key once the call returns.

remove

open fun remove(
    key: Any?, 
    value: Any?
): Boolean

Removes the entry for the specified key only if it is currently mapped to the specified value.

replace

open fun replace(
    key: K, 
    value: V
): V?

Replaces the entry for the specified key only if it is currently mapped to some value.

replace

open fun replace(
    key: K, 
    oldValue: V, 
    newValue: V
): Boolean

Replaces the entry for the specified key only if currently mapped to the specified value.

replaceAll

open fun replaceAll(function: BiFunction<in K, in V, out V>): Unit

Replaces each entry's value with the result of invoking the given function on that entry until all entries have been processed or the function throws an exception. Exceptions thrown by the function are relayed to the caller.

size

abstract fun size(): Int

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

values

abstract fun values(): MutableCollection<V>

Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.