MutableMap

kotlin-stdlib/kotlin.collections/MutableMap

Требования к платформе и версии: Common (1.0)

expect interface MutableMap<K, V> : Map<K, V>

Коллекция, содержащая пары объектов (ключи и значения) и поддерживающая получение значения, соответствующего каждому ключу, а также добавление новых, удаление или обновление существующих пар.

Ключи Map уникальны; карта хранит только одно значение для каждого ключа. При этом одно и то же значение может быть связано с несколькими уникальными ключами.

Если для конкретного сценария использования изменение карты не требуется, вместо неё можно использовать доступный только для чтения аналог — Map.

MutableMap расширяет контракт Map, добавляя функции для добавления, удаления и обновления соответствий между ключами и значениями.

В отличие от Map, коллекции keys, values и entries являются изменяемыми, и изменения в них обновляют карту.

Если не указано иное, реализации MutableMap не являются потокобезопасными, и их изменение без явной синхронизации может привести к повреждению или потере данных и ошибкам во время выполнения.

Параметры типа

тип ключей карты. Тип ключа карты инвариантен.

тип значений карты. Тип значения изменяемой карты инвариантен.

Наследники

AbstractMutableMap

HashMap

LinkedHashMap

Требования к платформе и версии: JS (1.1)

actual interface MutableMap<K, V> : Map<K, V>

В отличие от Map, коллекции keys, values и entries являются изменяемыми, и изменения в них обновляют карту.

Параметры типа

тип ключей карты. Тип ключа карты инвариантен.

тип значений карты. Тип значения изменяемой карты инвариантен.

Наследники

AbstractMutableMap

HashMap

LinkedHashMap

Требования к платформе и версии: JVM (1.0)

actual interface MutableMap<K, V> : Map<K, V>

Ключи Map уникальны; карта хранит только одно значение для каждого ключа. При этом значения могут дублироваться: одному и тому же значению могут соответствовать несколько уникальных ключей.

В отличие от Map, итераторы, возвращаемые коллекциями keys, values и entries, являются изменяемыми и позволяют обновлять карту во время итерации.

Согласно соглашению, реализации MutableMap обычно также реализуют интерфейс java.io.Serializable.

Параметры типа

тип ключей карты. Тип ключа карты инвариантен.

тип значений карты. Тип значения изменяемой карты инвариантен.

Наследники

AbstractMutableMap

Требования к платформе и версии: Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

actual interface MutableMap<K, V> : Map<K, V>

В отличие от Map, коллекции keys, values и entries являются изменяемыми, и изменения в них обновляют карту.

Параметры типа

тип ключей карты. Тип ключа карты инвариантен.

тип значений карты. Тип значения изменяемой карты инвариантен.

Наследники

AbstractMutableMap

HashMap

Типы

MutableEntry

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect interface MutableEntry<K, V> : Map.Entry<K, V>

Представляет пару ключ/значение, содержащуюся в MutableMap.

Свойства

entries

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

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

Возвращает MutableSet со всеми парами ключ/значение в этой карте.

keys

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract override val keys: MutableSet<K>

Возвращает MutableSet со всеми ключами этой карты.

size

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract val size: Int

Возвращает количество пар ключ/значение в карте.

values

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract override val values: MutableCollection<V>

Возвращает MutableCollection со всеми значениями этой карты. Обратите внимание, что эта коллекция может содержать повторяющиеся значения.

Функции

all

Требования к платформе и версии: Common (1.0)

inline fun <K, V> Map<out K, V>.all(predicate: (Map.Entry<K, V>) -> Boolean): Boolean

Возвращает true, если все элементы соответствуют заданному предикату.

any

Требования к платформе и версии: Common (1.0)

fun <K, V> Map<out K, V>.any(): Boolean

Возвращает true, если карта содержит хотя бы один элемент.

inline fun <K, V> Map<out K, V>.any(predicate: (Map.Entry<K, V>) -> Boolean): Boolean

Возвращает true, если хотя бы один элемент соответствует заданному предикату.

asIterable

Требования к платформе и версии: Common (1.0)

inline fun <K, V> Map<out K, V>.asIterable(): Iterable<Map.Entry<K, V>>

Создает экземпляр Iterable, оборачивающий исходную карту и возвращающий ее элементы при итерации.

asJsMapView

Требования к платформе и версии: JS (2.0)



@ExperimentalJsExport


@ExperimentalJsCollectionsApi

open fun asJsMapView(): JsMap<K, V>

Возвращает представление с методами JsMap, позволяющее использовать его в JavaScript как обычную Map. Структурные изменения базовой карты синхронизируются с представлением, и наоборот.

asJsReadonlyMapView

Требования к платформе и версии: JS (2.0)



@ExperimentalJsExport


@ExperimentalJsCollectionsApi

open fun asJsReadonlyMapView(): JsReadonlyMap<K, V>

Возвращает представление с методами JsReadonlyMap, позволяющее использовать его в JavaScript как обычную неизменяемую Map. Структурные изменения базовой карты синхронизируются с представлением.

asSequence

Требования к платформе и версии: Common (1.0)

fun <K, V> Map<out K, V>.asSequence(): Sequence<Map.Entry<K, V>>

Создает экземпляр Sequence, оборачивающий исходную карту и возвращающий ее элементы при итерации.

clear

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract fun clear()

Удаляет все элементы из этой карты.

contains

Требования к платформе и версии: Common (1.0)

inline operator fun <K, V> Map<out K, V>.contains(key: K): Boolean

Проверяет, содержит ли карта заданный ключ.

containsKey

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract fun containsKey(key: K): Boolean

Возвращает true, если карта содержит указанный ключ.

containsKey

Требования к платформе и версии: Common (1.0)

inline fun <K> Map<out K, *>.containsKey(key: K): Boolean

Возвращает true, если карта содержит указанный ключ.

containsValue

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract fun containsValue(value: V): Boolean

Возвращает true, если карта связывает один или несколько ключей с указанным значением.

containsValue

Требования к платформе и версии: Common (1.0)

inline fun <K, V> Map<K, V>.containsValue(value: V): Boolean

Возвращает true, если карта связывает один или несколько ключей с указанным значением.

count

Требования к платформе и версии: Common (1.0)

inline fun <K, V> Map<out K, V>.count(): Int

Возвращает количество элементов в этой карте.

inline fun <K, V> Map<out K, V>.count(predicate: (Map.Entry<K, V>) -> Boolean): Int

Возвращает количество элементов, соответствующих заданному предикату.

filter

Требования к платформе и версии: Common (1.0)

inline fun <K, V> Map<out K, V>.filter(predicate: (Map.Entry<K, V>) -> Boolean): Map<K, V>

Возвращает новую карту, содержащую все пары «ключ-значение», соответствующие заданному предикату.

filterKeys

Требования к платформе и версии: Common (1.0)

inline fun <K, V> Map<out K, V>.filterKeys(predicate: (K) -> Boolean): Map<K, V>

Возвращает карту, содержащую все пары «ключ-значение» с ключами, соответствующими заданному предикату.

filterNot

Требования к платформе и версии: Common (1.0)

inline fun <K, V> Map<out K, V>.filterNot(predicate: (Map.Entry<K, V>) -> Boolean): Map<K, V>

Возвращает новую карту, содержащую все пары «ключ-значение», не соответствующие заданному предикату.

filterNotTo

Требования к платформе и версии: Common (1.0)


@IgnorableReturnValue
inline fun <K, V, M : MutableMap<in K, in V>> Map<out K, V>.filterNotTo(destination: M, predicate: (Map.Entry<K, V>) -> Boolean): M

Добавляет все элементы, не соответствующие заданному предикату, в указанное назначение.

filterTo

Требования к платформе и версии: Common (1.0)


@IgnorableReturnValue
inline fun <K, V, M : MutableMap<in K, in V>> Map<out K, V>.filterTo(destination: M, predicate: (Map.Entry<K, V>) -> Boolean): M

Добавляет все элементы, соответствующие заданному предикату, в изменяемую карту, указанную в качестве параметра назначения.

filterValues

Требования к платформе и версии: Common (1.0)

inline fun <K, V> Map<out K, V>.filterValues(predicate: (V) -> Boolean): Map<K, V>

Возвращает карту, содержащую все пары «ключ-значение» со значениями, соответствующими заданному предикату.

firstNotNullOf

Требования к платформе и версии: Common (1.5)

inline fun <K, V, R : Any> Map<out K, V>.firstNotNullOf(transform: (Map.Entry<K, V>) -> R?): R

Возвращает первое ненулевое значение, полученное функцией transform, примененной к элементам этой карты в порядке итерации, или выбрасывает NoSuchElementException, если ненулевое значение не было получено.

firstNotNullOfOrNull

Требования к платформе и версии: Common (1.5)

inline fun <K, V, R : Any> Map<out K, V>.firstNotNullOfOrNull(transform: (Map.Entry<K, V>) -> R?): R?

Возвращает первое ненулевое значение, полученное функцией transform, примененной к элементам этой карты в порядке итерации, или null, если ненулевое значение не было получено.

flatMap

Требования к платформе и версии: Common (1.0)

inline fun <K, V, R> Map<out K, V>.flatMap(transform: (Map.Entry<K, V>) -> Iterable<R>): List<R>

Возвращает единый список всех элементов, полученных из результатов вызова функции transform для каждого элемента исходной карты.


@JvmName(name = "flatMapSequence")
inline fun <K, V, R> Map<out K, V>.flatMap(transform: (Map.Entry<K, V>) -> Sequence<R>): List<R>

flatMapTo

Требования к платформе и версии: Common (1.0)


@IgnorableReturnValue
inline fun <K, V, R, C : MutableCollection<in R>> Map<out K, V>.flatMapTo(destination: C, transform: (Map.Entry<K, V>) -> Iterable<R>): C

Добавляет все элементы, полученные из результатов вызова функции transform для каждого элемента исходной карты, в указанное назначение.



@JvmName(name = "flatMapSequenceTo")


@IgnorableReturnValue

inline fun <K, V, R, C : MutableCollection<in R>> Map<out K, V>.flatMapTo(destination: C, transform: (Map.Entry<K, V>) -> Sequence<R>): C

forEach

Требования к платформе и версии: Common (1.0)

inline fun <K, V> Map<out K, V>.forEach(action: (Map.Entry<K, V>) -> Unit)

Выполняет заданное действие для каждого элемента.

get

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract operator fun get(key: K): V?

Возвращает значение, соответствующее заданному ключу, или null, если такого ключа нет в карте.

get

Требования к платформе и версии: Common (1.0)

inline operator fun <K, V> Map<out K, V>.get(key: K): V?

Возвращает значение, соответствующее заданному ключу, или null, если такого ключа нет в карте.

getOrDefault

Требования к платформе и версии: JVM (1.2)

inline fun <K, V> Map<out K, V>.getOrDefault(key: K, defaultValue: V): V

Возвращает значение, связанное с указанным ключом, или defaultValue, если в этой карте нет соответствия для данного ключа.

getOrElse

Требования к платформе и версии: Common (1.0)

inline fun <K, V> Map<K, V>.getOrElse(key: K, defaultValue: () -> V): V

Возвращает значение для заданного ключа, если оно присутствует и не равно null. В противном случае возвращает результат функции defaultValue.

getOrElseIfMissing

Требования к платформе и версии: Common (2.4)


@ExperimentalStdlibApi
inline fun <K, V> Map<K, V>.getOrElseIfMissing(key: K, defaultValue: () -> V): V

Возвращает значение для заданного ключа, если оно присутствует. В противном случае возвращает результат функции defaultValue.

getOrElseIfNull

Требования к платформе и версии: Common (2.4)


@ExperimentalStdlibApi
inline fun <K, V> Map<K, V>.getOrElseIfNull(key: K, defaultValue: () -> V): V

getOrPut

Требования к платформе и версии: Common (1.0)

inline fun <K, V> MutableMap<K, V>.getOrPut(key: K, defaultValue: () -> V): V

Возвращает значение для заданного ключа, если оно присутствует и не равно null. В противном случае вызывает функцию defaultValue, помещает ее результат в карту под заданным ключом и возвращает результат вызова.

getOrPutIfMissing

Требования к платформе и версии: Common (2.4)


@ExperimentalStdlibApi
inline fun <K, V> MutableMap<K, V>.getOrPutIfMissing(key: K, crossinline defaultValue: () -> V): V

Возвращает значение для заданного ключа, если оно присутствует. В противном случае вызывает функцию defaultValue, помещает ее результат в карту под заданным ключом и возвращает результат вызова.

getOrPutIfNull

Требования к платформе и версии: Common (2.4)


@ExperimentalStdlibApi
inline fun <K, V> MutableMap<K, V>.getOrPutIfNull(key: K, crossinline defaultValue: () -> V): V

getValue

Требования к платформе и версии: Common (1.1)

fun <K, V> Map<K, V>.getValue(key: K): V

Возвращает значение для заданного ключа или выбрасывает исключение, если такого ключа нет в карте.

inline operator fun <V, V1 : V> Map<in String, V>.getValue(thisRef: Any?, property: KProperty<*>): V1

Возвращает значение свойства для заданного объекта из этой неизменяемой карты.


@JvmName(name = "getVar")
inline operator fun <V, V1 : V> MutableMap<in String, out V>.getValue(thisRef: Any?, property: KProperty<*>): V1

Возвращает значение свойства для заданного объекта из этой изменяемой карты.

isEmpty

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract fun isEmpty(): Boolean

Возвращает true, если карта пуста (не содержит элементов), и false в противном случае.

isNotEmpty

Требования к платформе и версии: Common (1.0)

inline fun <K, V> Map<out K, V>.isNotEmpty(): Boolean

Возвращает true, если эта карта не пуста.

isNullOrEmpty

Требования к платформе и версии: Common (1.3)

inline fun <K, V> Map<out K, V>?.isNullOrEmpty(): Boolean

Возвращает true, если эта nullable-карта равна null или пуста.

iterator

Требования к платформе и версии: Common (1.0)

inline operator fun <K, V> Map<out K, V>.iterator(): Iterator<Map.Entry<K, V>>

Возвращает Iterator для элементов Map.


@JvmName(name = "mutableIterator")
inline operator fun <K, V> MutableMap<K, V>.iterator(): MutableIterator<MutableMap.MutableEntry<K, V>>

Возвращает MutableIterator для изменяемых элементов MutableMap.

map

Требования к платформе и версии: Common (1.0)

inline fun <K, V, R> Map<out K, V>.map(transform: (Map.Entry<K, V>) -> R): List<R>

Возвращает список, содержащий результаты применения заданной функции transform к каждому элементу исходной карты.

mapKeys

Требования к платформе и версии: Common (1.0)

inline fun <K, V, R> Map<out K, V>.mapKeys(transform: (Map.Entry<K, V>) -> R): Map<R, V>

Возвращает новую Map с элементами, ключи которых получены применением функции transform к каждому элементу этой Map, а значения взяты из этой карты.

mapKeysTo

Требования к платформе и версии: Common (1.0)


@IgnorableReturnValue
inline fun <K, V, R, M : MutableMap<in R, in V>> Map<out K, V>.mapKeysTo(destination: M, transform: (Map.Entry<K, V>) -> R): M

Заполняет указанную карту назначения элементами, ключи которых получены применением функции transform к каждому элементу этой Map, а значения взяты из этой карты.

mapNotNull

Требования к платформе и версии: Common (1.0)

inline fun <K, V, R : Any> Map<out K, V>.mapNotNull(transform: (Map.Entry<K, V>) -> R?): List<R>

Возвращает список, содержащий только ненулевые результаты применения заданной функции transform к каждому элементу исходной карты.

mapNotNullTo

Требования к платформе и версии: Common (1.0)


@IgnorableReturnValue
inline fun <K, V, R : Any, C : MutableCollection<in R>> Map<out K, V>.mapNotNullTo(destination: C, transform: (Map.Entry<K, V>) -> R?): C

Применяет заданную функцию transform к каждому элементу исходной карты и добавляет только ненулевые результаты в указанное назначение.

mapTo

Требования к платформе и версии: Common (1.0)


@IgnorableReturnValue
inline fun <K, V, R, C : MutableCollection<in R>> Map<out K, V>.mapTo(destination: C, transform: (Map.Entry<K, V>) -> R): C

Применяет заданную функцию transform к каждому элементу исходной карты и добавляет результаты в указанное назначение.

mapValues

Требования к платформе и версии: Common (1.0)

inline fun <K, V, R> Map<out K, V>.mapValues(transform: (Map.Entry<K, V>) -> R): Map<K, R>

Возвращает новую карту с ключами из этой карты и значениями, полученными применением функции transform к каждому элементу этой Map.

mapValuesTo

Требования к платформе и версии: Common (1.0)


@IgnorableReturnValue
inline fun <K, V, R, M : MutableMap<in K, in R>> Map<out K, V>.mapValuesTo(destination: M, transform: (Map.Entry<K, V>) -> R): M

Заполняет указанную карту назначения элементами с ключами из этой карты и значениями, полученными применением функции transform к каждому элементу этой Map.

maxBy

Требования к платформе и версии: Common (1.7)


@JvmName(name = "maxByOrThrow")
inline fun <K, V, R : Comparable<R>> Map<out K, V>.maxBy(selector: (Map.Entry<K, V>) -> R): Map.Entry<K, V>

Возвращает первый элемент, для которого функция selector выдает наибольшее значение.

Требования к платформе и версии: JVM (1.0)

inline fun <K, V, R : Comparable<R>> Map<out K, V>.maxBy(selector: (Map.Entry<K, V>) -> R): Map.Entry<K, V>?

maxByOrNull

Требования к платформе и версии: Common (1.4)

inline fun <K, V, R : Comparable<R>> Map<out K, V>.maxByOrNull(selector: (Map.Entry<K, V>) -> R): Map.Entry<K, V>?

Возвращает первую запись, для которой функция selector возвращает наибольшее значение, или null, если записей нет.

maxOf

Требования к платформе и версии: Common (1.4)

inline fun <K, V, R : Comparable<R>> Map<out K, V>.maxOf(selector: (Map.Entry<K, V>) -> R): R

inline fun <K, V> Map<out K, V>.maxOf(selector: (Map.Entry<K, V>) -> Double): Double

inline fun <K, V> Map<out K, V>.maxOf(selector: (Map.Entry<K, V>) -> Float): Float

Возвращает наибольшее значение среди всех значений, полученных функцией selector, применённой к каждой записи в map.

maxOfOrNull

Требования к платформе и версии: Common (1.4)

inline fun <K, V, R : Comparable<R>> Map<out K, V>.maxOfOrNull(selector: (Map.Entry<K, V>) -> R): R?

inline fun <K, V> Map<out K, V>.maxOfOrNull(selector: (Map.Entry<K, V>) -> Double): Double?

inline fun <K, V> Map<out K, V>.maxOfOrNull(selector: (Map.Entry<K, V>) -> Float): Float?

Возвращает наибольшее значение среди всех значений, полученных функцией selector, применённой к каждой записи в map, или null, если map пуста.

maxOfWith

Требования к платформе и версии: Common (1.4)

inline fun <K, V, R> Map<out K, V>.maxOfWith(comparator: Comparator<in R>, selector: (Map.Entry<K, V>) -> R): R

Возвращает наибольшее значение согласно заданному comparator среди всех значений, полученных функцией selector, применённой к каждой записи в map.

maxOfWithOrNull

Требования к платформе и версии: Common (1.4)

inline fun <K, V, R> Map<out K, V>.maxOfWithOrNull(comparator: Comparator<in R>, selector: (Map.Entry<K, V>) -> R): R?

Возвращает наибольшее значение согласно заданному comparator среди всех значений, полученных функцией selector, применённой к каждой записи в map, или null, если map пуста.

maxWith

Требования к платформе и версии: Common (1.7)


@JvmName(name = "maxWithOrThrow")
inline fun <K, V> Map<out K, V>.maxWith(comparator: Comparator<in Map.Entry<K, V>>): Map.Entry<K, V>

Возвращает первую запись с наибольшим значением согласно заданному comparator.

Требования к платформе и версии: JVM (1.0)

inline fun <K, V> Map<out K, V>.maxWith(comparator: Comparator<in Map.Entry<K, V>>): Map.Entry<K, V>?

maxWithOrNull

Требования к платформе и версии: Common (1.4)

inline fun <K, V> Map<out K, V>.maxWithOrNull(comparator: Comparator<in Map.Entry<K, V>>): Map.Entry<K, V>?

Возвращает первую запись с наибольшим значением согласно заданному comparator или null, если записей нет.

minBy

Требования к платформе и версии: Common (1.7)


@JvmName(name = "minByOrThrow")
inline fun <K, V, R : Comparable<R>> Map<out K, V>.minBy(selector: (Map.Entry<K, V>) -> R): Map.Entry<K, V>

Возвращает первую запись, для которой функция selector возвращает наименьшее значение.

Требования к платформе и версии: JVM (1.0)

inline fun <K, V, R : Comparable<R>> Map<out K, V>.minBy(selector: (Map.Entry<K, V>) -> R): Map.Entry<K, V>?

minByOrNull

Требования к платформе и версии: Common (1.4)

inline fun <K, V, R : Comparable<R>> Map<out K, V>.minByOrNull(selector: (Map.Entry<K, V>) -> R): Map.Entry<K, V>?

Возвращает первую запись, для которой функция selector возвращает наименьшее значение, или null, если записей нет.

minOf

Требования к платформе и версии: Common (1.4)

inline fun <K, V, R : Comparable<R>> Map<out K, V>.minOf(selector: (Map.Entry<K, V>) -> R): R

inline fun <K, V> Map<out K, V>.minOf(selector: (Map.Entry<K, V>) -> Double): Double

inline fun <K, V> Map<out K, V>.minOf(selector: (Map.Entry<K, V>) -> Float): Float

Возвращает наименьшее значение среди всех значений, полученных функцией selector, применённой к каждой записи в map.

minOfOrNull

Требования к платформе и версии: Common (1.4)

inline fun <K, V, R : Comparable<R>> Map<out K, V>.minOfOrNull(selector: (Map.Entry<K, V>) -> R): R?

inline fun <K, V> Map<out K, V>.minOfOrNull(selector: (Map.Entry<K, V>) -> Double): Double?

inline fun <K, V> Map<out K, V>.minOfOrNull(selector: (Map.Entry<K, V>) -> Float): Float?

Возвращает наименьшее значение среди всех значений, полученных функцией selector, применённой к каждой записи в map, или null, если map пуста.

minOfWith

Требования к платформе и версии: Common (1.4)

inline fun <K, V, R> Map<out K, V>.minOfWith(comparator: Comparator<in R>, selector: (Map.Entry<K, V>) -> R): R

Возвращает наименьшее значение согласно заданному comparator среди всех значений, полученных функцией selector, применённой к каждой записи в map.

minOfWithOrNull

Требования к платформе и версии: Common (1.4)

inline fun <K, V, R> Map<out K, V>.minOfWithOrNull(comparator: Comparator<in R>, selector: (Map.Entry<K, V>) -> R): R?

Возвращает наименьшее значение согласно заданному comparator среди всех значений, полученных функцией selector, применённой к каждой записи в map, или null, если map пуста.

minus

Требования к платформе и версии: Common (1.1)

operator fun <K, V> Map<out K, V>.minus(key: K): Map<K, V>

Возвращает map, содержащую все записи исходной map, кроме записи с заданным key.

operator fun <K, V> Map<out K, V>.minus(keys: Array<out K>): Map<K, V>

Возвращает map, содержащую все записи исходной map, кроме записей, ключи которых содержатся в заданном массиве keys.

operator fun <K, V> Map<out K, V>.minus(keys: Iterable<K>): Map<K, V>

Возвращает map, содержащую все записи исходной map, кроме записей, ключи которых содержатся в заданной коллекции keys.

operator fun <K, V> Map<out K, V>.minus(keys: Sequence<K>): Map<K, V>

Возвращает map, содержащую все записи исходной map, кроме записей, ключи которых содержатся в заданной последовательности keys.

minusAssign

Требования к платформе и версии: Common (1.1)

inline operator fun <K, V> MutableMap<K, V>.minusAssign(key: K)

Удаляет из этой изменяемой map запись с заданным key.

inline operator fun <K, V> MutableMap<K, V>.minusAssign(keys: Array<out K>)

Удаляет из этой изменяемой map все записи, ключи которых содержатся в заданном массиве keys.

inline operator fun <K, V> MutableMap<K, V>.minusAssign(keys: Iterable<K>)

Удаляет из этой изменяемой map все записи, ключи которых содержатся в заданной коллекции keys.

inline operator fun <K, V> MutableMap<K, V>.minusAssign(keys: Sequence<K>)

Удаляет из этой изменяемой map все записи, ключи которых содержатся в заданной последовательности keys.

minWith

Требования к платформе и версии: Common (1.7)


@JvmName(name = "minWithOrThrow")
inline fun <K, V> Map<out K, V>.minWith(comparator: Comparator<in Map.Entry<K, V>>): Map.Entry<K, V>

Возвращает первую запись с наименьшим значением согласно заданному comparator.

Требования к платформе и версии: JVM (1.0)

fun <K, V> Map<out K, V>.minWith(comparator: Comparator<in Map.Entry<K, V>>): Map.Entry<K, V>?

minWithOrNull

Требования к платформе и версии: Common (1.4)

inline fun <K, V> Map<out K, V>.minWithOrNull(comparator: Comparator<in Map.Entry<K, V>>): Map.Entry<K, V>?

Возвращает первую запись с наименьшим значением согласно заданному comparator или null, если записей нет.

none

Требования к платформе и версии: Common (1.0)

fun <K, V> Map<out K, V>.none(): Boolean

Возвращает true, если map не содержит записей.

inline fun <K, V> Map<out K, V>.none(predicate: (Map.Entry<K, V>) -> Boolean): Boolean

Возвращает true, если ни одна запись не соответствует заданному predicate.

orEmpty

Требования к платформе и версии: Common (1.0)

inline fun <K, V> Map<K, V>?.orEmpty(): Map<K, V>

Возвращает Map, если она не null, или пустую Map в противном случае.

plus

Требования к платформе и версии: Common (1.0)

operator fun <K, V> Map<out K, V>.plus(pairs: Array<out Pair<K, V>>): Map<K, V>

Создаёт новую map только для чтения, заменяя или добавляя в эту map записи из заданного массива пар «ключ-значение» pairs.

operator fun <K, V> Map<out K, V>.plus(pair: Pair<K, V>): Map<K, V>

Создаёт новую map только для чтения, заменяя или добавляя в эту map запись из заданной пары «ключ-значение» pair.

operator fun <K, V> Map<out K, V>.plus(pairs: Iterable<Pair<K, V>>): Map<K, V>

Создаёт новую map только для чтения, заменяя или добавляя в эту map записи из заданной коллекции пар «ключ-значение» pairs.

operator fun <K, V> Map<out K, V>.plus(map: Map<out K, V>): Map<K, V>

Создаёт новую map только для чтения, заменяя или добавляя в эту map записи из другой map.

operator fun <K, V> Map<out K, V>.plus(pairs: Sequence<Pair<K, V>>): Map<K, V>

Создаёт новую map только для чтения, заменяя или добавляя в эту map записи из заданной последовательности пар «ключ-значение» pairs.

plusAssign

Требования к платформе и версии: Common (1.0)

inline operator fun <K, V> MutableMap<in K, in V>.plusAssign(pairs: Array<out Pair<K, V>>)

Добавляет в эту изменяемую map все пары из заданного массива pairs или заменяет ими существующие.

inline operator fun <K, V> MutableMap<in K, in V>.plusAssign(pair: Pair<K, V>)

Добавляет в эту изменяемую map заданную pair или заменяет ею существующую.

inline operator fun <K, V> MutableMap<in K, in V>.plusAssign(pairs: Iterable<Pair<K, V>>)

Добавляет в эту изменяемую map все пары из заданной коллекции pairs или заменяет ими существующие.

inline operator fun <K, V> MutableMap<in K, in V>.plusAssign(map: Map<K, V>)

Добавляет в эту изменяемую map все записи из заданной map или заменяет ими существующие.

inline operator fun <K, V> MutableMap<in K, in V>.plusAssign(pairs: Sequence<Pair<K, V>>)

Добавляет в эту изменяемую map все пары из заданной последовательности pairs или заменяет ими существующие.

put

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)


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

Связывает указанное value с указанным key в map.

putAll

Требования к платформе и версии: Common (1.0), JS (1.1), JVM (1.0), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)

expect abstract fun putAll(from: Map<out K, V>)

Обновляет эту map парами «ключ/значение» из указанной map from.

putAll

Требования к платформе и версии: Common (1.0)

fun <K, V> MutableMap<in K, in V>.putAll(pairs: Array<out Pair<K, V>>)

Добавляет все заданные pairs в эту MutableMap, используя первый компонент пары в качестве ключа, а второй — в качестве значения.

fun <K, V> MutableMap<in K, in V>.putAll(pairs: Iterable<Pair<K, V>>)

Добавляет все элементы заданной коллекции в эту MutableMap, используя первый компонент пары в качестве ключа, а второй — в качестве значения.

fun <K, V> MutableMap<in K, in V>.putAll(pairs: Sequence<Pair<K, V>>)

Добавляет все элементы заданной последовательности в эту MutableMap, используя первый компонент пары в качестве ключа, а второй — в качестве значения.

remove

Требования к платформе и версии: Common (1.0), JS (1.1), Native (1.3), Wasm-JS (1.8), Wasm-WASI (1.8)


@IgnorableReturnValue
expect abstract fun remove(key: K): V?

Удаляет из этой map указанный ключ и соответствующее ему значение.

remove

Требования к платформе и версии: Common (1.0)


@IgnorableReturnValue
inline fun <K, V> MutableMap<out K, V>.remove(key: K): V?

Удаляет из этой map указанный ключ и соответствующее ему значение.

Требования к платформе и версии: JVM (1.2)


@IgnorableReturnValue
inline fun <K, V> MutableMap<out K, out V>.remove(key: K, value: V): Boolean

Удаляет запись для указанного ключа только в том случае, если сейчас с ним связано указанное значение.

set

Требования к платформе и версии: Common (1.0)

inline operator fun <K, V> MutableMap<K, V>.set(key: K, value: V)

Позволяет использовать оператор индексирования для сохранения значений в изменяемой map.

setValue

Требования к платформе и версии: Common (1.0)

inline operator fun <V> MutableMap<in String, in V>.setValue(thisRef: Any?, property: KProperty<*>, value: V)

Сохраняет значение свойства для заданного объекта в этой изменяемой map.

toList

Требования к платформе и версии: Common (1.0)

fun <K, V> Map<out K, V>.toList(): List<Pair<K, V>>

Возвращает List, содержащий все пары «ключ-значение».

toMap

Требования к платформе и версии: Common (1.1)

fun <K, V> Map<out K, V>.toMap(): Map<K, V>

Возвращает новую map только для чтения, содержащую все пары «ключ-значение» из исходной map.


@IgnorableReturnValue
fun <K, V, M : MutableMap<in K, in V>> Map<out K, V>.toMap(destination: M): M

Заполняет изменяемую map-destination парами «ключ-значение» из заданной map и возвращает её.

toMutableMap

Требования к платформе и версии: Common (1.1)

fun <K, V> Map<out K, V>.toMutableMap(): MutableMap<K, V>

Возвращает новую изменяемую map, содержащую все пары «ключ-значение» из исходной map.

toProperties

Требования к платформе и версии: JVM (1.0)

inline fun Map<String, String>.toProperties(): Properties

Преобразует эту Map в объект Properties.

toSortedMap

Требования к платформе и версии: JVM (1.0)

fun <K : Comparable<K>, V> Map<out K, V>.toSortedMap(): SortedMap<K, V>

Преобразует эту Map в SortedMap. Полученная SortedMap определяет равенство и порядок ключей в соответствии с их естественным порядком сортировки.

fun <K, V> Map<out K, V>.toSortedMap(comparator: Comparator<in K>): SortedMap<K, V>

Преобразует эту Map в SortedMap. Полученная SortedMap определяет равенство и порядок ключей в соответствии с порядком сортировки, заданным с помощью comparator.

withDefault

Требования к платформе и версии: Common (1.0)

fun <K, V> Map<K, V>.withDefault(defaultValue: (key: K) -> V): Map<K, V>

Возвращает обёртку этой map только для чтения с неявным значением по умолчанию, заданным функцией defaultValue.


@JvmName(name = "withDefaultMutable")
fun <K, V> MutableMap<K, V>.withDefault(defaultValue: (key: K) -> V): MutableMap<K, V>

Возвращает обёртку этой изменяемой map с неявным значением по умолчанию, заданным функцией defaultValue.

© 2010–2026 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-map/index.html