MutableMap
interface MutableMap<K, V> : Map<K, V>
Изменяемая коллекция, которая хранит пары объектов (ключи и значения) и поддерживает эффективное получение значения, соответствующего каждому ключу. Ключи карты уникальны; карта хранит только одно значение для каждого ключа.
Параметры
K - тип ключей карты. Карта инвариантна по отношению к типу ключа.
V - тип значений карты. Изменяемая карта инвариантна по отношению к типу значения.
Типы
MutableEntry
Представляет пару ключ/значение, хранящуюся в MutableMap.
interface MutableEntry<K, V> : Entry<K, V>
Свойства
entries
Возвращает MutableSet всех пар ключ/значение в этой карте.
abstract val entries: MutableSet<MutableEntry<K, V>>
keys
Возвращает MutableSet всех ключей в этой карте.
abstract val keys: MutableSet<K>
values
Возвращает MutableCollection всех значений в этой карте. Обратите внимание, что эта коллекция может содержать повторяющиеся значения.
abstract val values: MutableCollection<V>
Функции
clear
Удаляет все элементы из этой карты.
abstract fun clear()
put
putAll
Обновляет эту карту парами ключ/значение из указанной карты from.
abstract fun putAll(from: Map<out K, V>)
remove
Удаляет указанный ключ и соответствующее ему значение из этой карты.
abstract fun remove(key: K): V?
Удаляет запись для указанного ключа только в том случае, если он сопоставлен с указанным значением.
open fun remove(key: K, value: V): Boolean
Дополнительные функции
все
Возвращает true если все записи соответствуют заданному
fun <K, V> Map<out K, V>.all(
predicate: (Entry<K, V>) -> Boolean
): Boolean
любая
Возвращает true если в map есть хотя бы одна запись.
fun <K, V> Map<out K, V>.any(): Boolean
Возвращает true если хотя бы одна запись соответствует заданному
fun <K, V> Map<out K, V>.any(
predicate: (Entry<K, V>) -> Boolean
): Boolean
asIterable
Создаёт экземпляр Iterable, который оборачивает исходную карту, возвращая её записи при итерации.
fun <K, V> Map<out K, V>.asIterable(): Iterable<Entry<K, V>>
asSequence
Создаёт экземпляр Sequence, который оборачивает исходную карту, возвращая её записи при итерации.
fun <K, V> Map<out K, V>.asSequence(): Sequence<Entry<K, V>>
содержит
Проверяет, содержит ли карта заданный ключ.
operator fun <K, V> Map<out K, V>.contains(key: K): Boolean
содержит ключ
Возвращает true если карта содержит указанный
fun <K> Map<out K, *>.containsKey(key: K): Boolean
содержит значение
Возвращает true если карта сопоставляет один или несколько ключей со значением, указанным в
fun <K, V> Map<K, V>.containsValue(value: V): Boolean
количество
Возвращает количество записей в данной карте.
fun <K, V> Map<out K, V>.count(): Int
Возвращает количество записей, соответствующих заданному
fun <K, V> Map<out K, V>.count(
predicate: (Entry<K, V>) -> Boolean
): Int
фильтр
Возвращает новую карту, содержащую все пары ключ-значение, соответствующие заданному
fun <K, V> Map<out K, V>.filter(
predicate: (Entry<K, V>) -> Boolean
): Map<K, V>
фильтр ключей
Возвращает карту, содержащую все пары ключ-значение, ключи которых соответствуют заданному
fun <K, V> Map<out K, V>.filterKeys(
predicate: (K) -> Boolean
): Map<K, V>
не фильтр
Возвращает новую карту, содержащую все пары ключ-значение, не соответствующие заданному
fun <K, V> Map<out K, V>.filterNot(
predicate: (Entry<K, V>) -> Boolean
): Map<K, V>
не фильтр в
Добавляет все записи, не соответствующие заданному .
fun <K, V, M : MutableMap<in K, in V>> Map<out K, V>.filterNotTo( destination: M, predicate: (Entry<K, V>) -> Boolean ): M
фильтр в
Добавляет все записи, соответствующие заданному .
fun <K, V, M : MutableMap<in K, in V>> Map<out K, V>.filterTo( destination: M, predicate: (Entry<K, V>) -> Boolean ): M
filterValues
Возвращает карту, содержащую все пары ключ-значение, значения которых соответствуют заданному
fun <K, V> Map<out K, V>.filterValues(
predicate: (V) -> Boolean
): Map<K, V>
firstNotNullOf
Возвращает первое не-null значение, полученное функцией исключение NoSuchElementException, если не было получено ни одного не-null значения.
fun <K, V, R : Any> Map<out K, V>.firstNotNullOf( transform: (Entry<K, V>) -> R? ): R
firstNotNullOfOrNull
Возвращает первое не-null значение, полученное функцией
fun <K, V, R : Any> Map<out K, V>.firstNotNullOfOrNull(
transform: (Entry<K, V>) -> R?
): R?
flatMap
Возвращает единственный список всех элементов, полученных из результатов функции
fun <K, V, R> Map<out K, V>.flatMap(
transform: (Entry<K, V>) -> Iterable<R>
): List<R>
fun <K, V, R> Map<out K, V>.flatMap( transform: (Entry<K, V>) -> Sequence<R> ): List<R>
flatMapTo
Добавляет все элементы, полученные из результатов функции .
fun <K, V, R, C : MutableCollection<in R>> Map<out K, V>.flatMapTo( destination: C, transform: (Entry<K, V>) -> Iterable<R> ): C
fun <K, V, R, C : MutableCollection<in R>> Map<out K, V>.flatMapTo( destination: C, transform: (Entry<K, V>) -> Sequence<R> ): C
forEach
Выполняет заданное
fun <K, V> Map<out K, V>.forEach(
action: (Entry<K, V>) -> Unit)
get
Возвращает значение, соответствующее заданному
operator fun <K, V> Map<out K, V>.get(key: K): V?
getOrElse
Возвращает значение для заданного ключа, или результат функции
fun <K, V> Map<K, V>.getOrElse(
key: K,
defaultValue: () -> V
): V
getOrPut
Возвращает значение для заданного ключа. Если ключ не найден в карте, вызывает функцию
fun <K, V> MutableMap<K, V>.getOrPut(
key: K,
defaultValue: () -> V
): V
getValue
Возвращает значение свойства для данного объекта из этой изменяемой карты.
operator fun <V, V1 : V> MutableMap<in String, out V>.getValue( thisRef: Any?, property: KProperty<*> ): V1
Возвращает значение для данного
fun <K, V> Map<K, V>.getValue(key: K): V
ifEmpty
Возвращает эту карту, если она не пустая, или результат вызова функции
fun <M, R> M.ifEmpty(
defaultValue: () -> R
): R where M : Map<*, *>, M : R
isNotEmpty
Возвращает значение true, если эта карта не пустая.
fun <K, V> Map<out K, V>.isNotEmpty(): Boolean
isNullOrEmpty
Возвращает значение true, если эта карта (возможно, нулевая) либо null, либо пуста.
fun <K, V> Map<out K, V>?.isNullOrEmpty(): Boolean
iterator
Возвращает MutableIterator для изменяемых записей в MutableMap.
operator fun <K, V> MutableMap<K, V>.iterator(): MutableIterator<MutableEntry<K, V>>
map
Возвращает список, содержащий результаты применения заданной функции transform к каждой записи в исходном отображении.
fun <K, V, R> Map<out K, V>.map( transform: (Entry<K, V>) -> R ): List<R>
mapKeys
mapKeysTo
Заполняет заданное отображение destination записями, ключи которых получены путем применения функции transform к каждой записи в этом Map, а значениями являются значения этого отображения.
fun <K, V, R, M : MutableMap<in R, in V>> Map<out K, V>.mapKeysTo( destination: M, transform: (Entry<K, V>) -> R ): M
mapNotNull
Возвращает список, содержащий только ненулевые результаты применения заданной функции transform к каждой записи в исходном отображении.
fun <K, V, R : Any> Map<out K, V>.mapNotNull( transform: (Entry<K, V>) -> R? ): List<R>
mapNotNullTo
Применяет заданную функцию transform к каждой записи в исходном отображении и добавляет только ненулевые результаты в заданный destination.
fun <K, V, R : Any, C : MutableCollection<in R>> Map<out K, V>.mapNotNullTo( destination: C, transform: (Entry<K, V>) -> R? ): C
mapTo
Применяет заданную функцию transform к каждой записи исходного отображения и добавляет результаты в заданный destination.
fun <K, V, R, C : MutableCollection<in R>> Map<out K, V>.mapTo( destination: C, transform: (Entry<K, V>) -> R ): C
mapValues
mapValuesTo
Заполняет заданное отображение destination записями, ключи которых являются ключами этого отображения, а значения получены путем применения функции transform к каждой записи в этом Map.
fun <K, V, R, M : MutableMap<in K, in R>> Map<out K, V>.mapValuesTo( destination: M, transform: (Entry<K, V>) -> R ): M
maxBy
fun <K, V, R : Comparable<R>> Map<out K, V>.maxBy( selector: (Entry<K, V>) -> R ): Entry<K, V>?
maxByOrNull
Возвращает первую запись, дающую наибольшее значение заданной функции, или null если записей нет.
fun <K, V, R : Comparable<R>> Map<out K, V>.maxByOrNull( selector: (Entry<K, V>) -> R ): Entry<K, V>?
maxOf
Возвращает наибольшее значение среди всех значений, полученных функцией selector, применённой к каждой записи в карте.
fun <K, V> Map<out K, V>.maxOf( selector: (Entry<K, V>) -> Double ): Double
fun <K, V> Map<out K, V>.maxOf( selector: (Entry<K, V>) -> Float ): Float
fun <K, V, R : Comparable<R>> Map<out K, V>.maxOf( selector: (Entry<K, V>) -> R ): R
maxOfOrNull
Возвращает наибольшее значение среди всех значений, полученных функцией selector, применённой к каждой записи в карте, или null если записей нет.
fun <K, V> Map<out K, V>.maxOfOrNull( selector: (Entry<K, V>) -> Double ): Double?
fun <K, V> Map<out K, V>.maxOfOrNull( selector: (Entry<K, V>) -> Float ): Float?
fun <K, V, R : Comparable<R>> Map<out K, V>.maxOfOrNull( selector: (Entry<K, V>) -> R ): R?
maxOfWith
Возвращает наибольшее значение в соответствии с заданным comparator среди всех значений, полученных функцией selector, применённой к каждой записи в карте.
fun <K, V, R> Map<out K, V>.maxOfWith( comparator: Comparator<in R>, selector: (Entry<K, V>) -> R ): R
maxOfWithOrNull
Возвращает наибольшее значение в соответствии с заданным comparator среди всех значений, полученных функцией selector, применённой к каждой записи в карте, или null если записей нет.
fun <K, V, R> Map<out K, V>.maxOfWithOrNull( comparator: Comparator<in R>, selector: (Entry<K, V>) -> R ): R?
maxWith
fun <K, V> Map<out K, V>.maxWith( comparator: Comparator<in Entry<K, V>> ): Entry<K, V>?
maxWithOrNull
Возвращает первую запись с наибольшим значением в соответствии с заданным comparator или null если записей нет.
fun <K, V> Map<out K, V>.maxWithOrNull( comparator: Comparator<in Entry<K, V>> ): Entry<K, V>?
minBy
fun <K, V, R : Comparable<R>> Map<out K, V>.minBy( selector: (Entry<K, V>) -> R ): Entry<K, V>?
minByOrNull
Возвращает первую запись, которая даёт наименьшее значение заданной функции, или null если записей нет.
fun <K, V, R : Comparable<R>> Map<out K, V>.minByOrNull( selector: (Entry<K, V>) -> R ): Entry<K, V>?
minOf
Возвращает наименьшее значение среди всех значений, полученных функцией selector, применённой к каждой записи в карте.
fun <K, V> Map<out K, V>.minOf( selector: (Entry<K, V>) -> Double ): Double
fun <K, V> Map<out K, V>.minOf( selector: (Entry<K, V>) -> Float ): Float
fun <K, V, R : Comparable<R>> Map<out K, V>.minOf( selector: (Entry<K, V>) -> R ): R
minOfOrNull
Возвращает наименьшее значение среди всех значений, полученных функцией selector, применённой к каждой записи в карте, или null если записей нет.
fun <K, V> Map<out K, V>.minOfOrNull( selector: (Entry<K, V>) -> Double ): Double?
fun <K, V> Map<out K, V>.minOfOrNull( selector: (Entry<K, V>) -> Float ): Float?
fun <K, V, R : Comparable<R>> Map<out K, V>.minOfOrNull( selector: (Entry<K, V>) -> R ): R?
minOfWith
Возвращает наименьшее значение в соответствии с заданным comparator среди всех значений, полученных функцией selector, применённой к каждой записи в карте.
fun <K, V, R> Map<out K, V>.minOfWith( comparator: Comparator<in R>, selector: (Entry<K, V>) -> R ): R
minOfWithOrNull
Возвращает наименьшее значение согласно предоставленному компаратору среди всех значений, полученных в результате применения функции выбора к каждой записи в карте или null если записей нет.
fun <K, V, R> Map<out K, V>.minOfWithOrNull( comparator: Comparator<in R>, selector: (Entry<K, V>) -> R ): R?
minus
Возвращает карту, содержащую все записи исходной карты, за исключением записи с заданным ключом.
operator fun <K, V> Map<out K, V>.minus(key: K): Map<K, V>
Возвращает карту, содержащую все записи исходной карты, за исключением тех записей, ключи которых содержатся в заданном наборе ключей.
operator fun <K, V> Map<out K, V>.minus( keys: Iterable<K> ): Map<K, V>
Возвращает карту, содержащую все записи исходной карты, за исключением тех записей, ключи которых содержатся в заданном массиве ключей.
operator fun <K, V> Map<out K, V>.minus( keys: Array<out K> ): Map<K, V>
Возвращает карту, содержащую все записи исходной карты, за исключением тех записей, ключи которых содержатся в заданной последовательности ключей.
operator fun <K, V> Map<out K, V>.minus( keys: Sequence<K> ): Map<K, V>
minusAssign
Удаляет запись с заданным ключом из этой изменяемой карты.
operator fun <K, V> MutableMap<K, V>.minusAssign(key: K)
Удаляет все записи, ключи которых содержатся в заданном наборе ключей из этой изменяемой карты.
operator fun <K, V> MutableMap<K, V>.minusAssign( keys: Iterable<K>)
Удаляет все записи, ключи которых содержатся в заданном массиве ключей из этой изменяемой карты.
operator fun <K, V> MutableMap<K, V>.minusAssign( keys: Array<out K>)
Удаляет все записи из ключей которых содержатся в заданной последовательности ключей из этой изменяемой карты.
operator fun <K, V> MutableMap<K, V>.minusAssign( keys: Sequence<K>)
minWith
fun <K, V> Map<out K, V>.minWith( comparator: Comparator<in Entry<K, V>> ): Entry<K, V>?
minWithOrNull
Возвращает первую запись с наименьшим значением согласно предоставленному компаратору или null если записей нет.
fun <K, V> Map<out K, V>.minWithOrNull( comparator: Comparator<in Entry<K, V>> ): Entry<K, V>?
none
Возвращает true если в карте нет записей.
fun <K, V> Map<out K, V>.none(): Boolean
Возвращает true если ни одна запись не соответствует заданному предикату.
fun <K, V> Map<out K, V>.none( predicate: (Entry<K, V>) -> Boolean ): Boolean
onEach
Выполняет заданное действие над каждой записью и возвращает саму карту после этого.
fun <K, V, M : Map<out K, V>> M.onEach( action: (Entry<K, V>) -> Unit ): M
onEachIndexed
Выполняет заданное действие над каждой записью, предоставляя порядковый индекс вместе с записью, и возвращает саму карту после этого.
fun <K, V, M : Map<out K, V>> M.onEachIndexed( action: (index: Int, Entry<K, V>) -> Unit ): M
plus
Создаёт новую неизменяемую карту, заменяя или добавляя в эту карту пару ключ-значение из заданной пары.
operator fun <K, V> Map<out K, V>.plus( pair: Pair<K, V> ): Map<K, V>
Создаёт новую неизменяемую карту, заменяя или добавляя в эту карту элементы из заданного набора пар ключ-значение пар.
operator fun <K, V> Map<out K, V>.plus( pairs: Iterable<Pair<K, V>> ): Map<K, V>
Создаёт новую неизменяемую карту, заменяя или добавляя в эту карту элементы из заданного массива пар ключ-значение пар.
operator fun <K, V> Map<out K, V>.plus( pairs: Array<out Pair<K, V>> ): Map<K, V>
Создаёт новую неизменяемую карту, заменяя или добавляя в эту карту элементы из заданной последовательности пар ключ-значение пар.
operator fun <K, V> Map<out K, V>.plus( pairs: Sequence<Pair<K, V>> ): Map<K, V>
Создаёт новую неизменяемую карту, заменяя или добавляя в эту карту элементы из другой карты.
operator fun <K, V> Map<out K, V>.plus( map: Map<out K, V> ): Map<K, V>
plusAssign
Добавляет или заменяет заданную пару в этой изменяемой карте.
operator fun <K, V> MutableMap<in K, in V>.plusAssign( pair: Pair<K, V>)
Добавляет или заменяет все пары из заданного набора пар в этой изменяемой карте.
operator fun <K, V> MutableMap<in K, in V>.plusAssign( pairs: Iterable<Pair<K, V>>)
Добавляет или заменяет все пары из заданного массива пар в этой изменяемой карте.
operator fun <K, V> MutableMap<in K, in V>.plusAssign( pairs: Array<out Pair<K, V>>)
Добавляет или заменяет все пары из заданной последовательности пар в этой изменяемой карте.
operator fun <K, V> MutableMap<in K, in V>.plusAssign( pairs: Sequence<Pair<K, V>>)
Добавляет или заменяет все элементы из заданной карты в этой изменяемой карте.
operator fun <K, V> MutableMap<in K, in V>.plusAssign( map: Map<K, V>)
putAll
Добавляет все заданные пары в эту MutableMap, где первый компонент пары — ключ, а второй — значение.
fun <K, V> MutableMap<in K, in V>.putAll( pairs: Array<out Pair<K, V>>)
Добавляет все элементы заданного набора в эту 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>>)
remove
Удаляет из этой карты указанный ключ и соответствующее ему значение.
fun <K, V> MutableMap<out K, V>.remove(key: K): V?
Удаляет запись для указанного ключа только в том случае, если он в настоящее время сопоставлен с указанным значением.
fun <K, V> MutableMap<out K, out V>.remove( key: K, value: V ): Boolean
set
Позволяет использовать оператор индекса для хранения значений в изменяемой карте.
operator fun <K, V> MutableMap<K, V>.set(key: K, value: V)
setValue
Сохраняет значение свойства для данного объекта в этой изменяемой карте.
operator fun <V> MutableMap<in String, in V>.setValue( thisRef: Any?, property: KProperty<*>, value: V)
toList
Возвращает список, содержащий все пары ключ-значение.
fun <K, V> Map<out K, V>.toList(): List<Pair<K, V>>
toMap
Возвращает новую неизменяемую карту, содержащую все пары ключ-значение из исходной карты.
fun <K, V> Map<out K, V>.toMap(): Map<K, V>
Заполняет и возвращает изменяемую карту назначения парами ключ-значение из заданной карты.
fun <K, V, M : MutableMap<in K, in V>> Map<out K, V>.toMap( destination: M ): M
toMutableMap
Возвращает новую изменяемую карту, содержащую все пары ключ-значение из исходной карты.
fun <K, V> Map<out K, V>.toMutableMap(): MutableMap<K, V>
toProperties
Преобразует эту карту Map в объект Properties.
fun Map<String, String>.toProperties(): Properties
toSortedMap
Преобразует эту карту Map в SortedMap. Результирующая SortedMap определяет равенство и порядок ключей в соответствии с порядком сортировки, заданным предоставленным компаратором.
fun <K, V> Map<out K, V>.toSortedMap( comparator: Comparator<in K> ): SortedMap<K, V>
withDefault
Возвращает обёртку этой изменяемой карты, имеющей неявное значение по умолчанию, предоставленное функцией defaultValue.
fun <K, V> MutableMap<K, V>.withDefault( defaultValue: (key: K) -> V ): MutableMap<K, V>
Возвращает обёртку этой неизменяемой карты, имеющей неявное значение по умолчанию, предоставленное функцией defaultValue.
fun <K, V> Map<K, V>.withDefault( defaultValue: (key: K) -> V ): Map<K, V>
Наследующие классы
AbstractMutableMap
Предоставляет скелетную реализацию интерфейса MutableMap.
abstract class AbstractMutableMap<K, V> : MutableMap<K, V>
abstract class AbstractMutableMap<K, V> : MutableMap<K, V>, AbstractMap<K, V>
abstract class AbstractMutableMap<K, V> : AbstractMap<K, V>, MutableMap<K, V>
HashMap
Реализация интерфейса MutableMap на основе хэш-таблицы.
class HashMap<K, V> : MutableMap<K, V>
typealias HashMap<K, V> = HashMap<K, V>
open class HashMap<K, V> : AbstractMutableMap<K, V>, MutableMap<K, V>
LinkedHashMap
Реализация интерфейса MutableMap на основе хэш-таблицы, которая дополнительно сохраняет порядок вставки записей во время итерации.
class LinkedHashMap<K, V> : MutableMap<K, V>
typealias LinkedHashMap<K, V> = LinkedHashMap<K, V>
open class LinkedHashMap<K, V> : HashMap<K, V>, MutableMap<K, V>
typealias LinkedHashMap<K, V> = HashMap<K, V>
© 2010–2022 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html