HashMap
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>
Реализация интерфейса MutableMap на основе хеш-таблицы.
Эта реализация не гарантирует порядок перечисления коллекций ключей, значений и пар ключ-значение.
Конструкторы
Свойства
entries
Возвращает MutableSet всех пар ключ/значение в этой карте.
val entries: MutableSet<MutableEntry<K, V>>
open val entries: MutableSet<MutableEntry<K, V>>
keys
Возвращает MutableSet всех ключей в этой карте.
val keys: MutableSet<K>
size
Возвращает количество пар ключ/значение в карте.
val size: Int
open val size: Int
values
Возвращает MutableCollection всех значений в этой карте. Обратите внимание, что эта коллекция может содержать повторяющиеся значения.
val values: MutableCollection<V>
Функции
clear
Удаляет все элементы из этой карты.
fun clear()
open fun clear()
containsKey
Возвращает true , если карта содержит указанный ключ.
fun containsKey(key: K): Boolean
open fun containsKey(key: K): Boolean
containsValue
Возвращает true , если карта сопоставляет один или несколько ключей указанному значению.
fun containsValue(value: V): Boolean
open fun containsValue(value: V): Boolean
equals
Указывает, является ли какой-либо другой объект "равным" данному. Реализации должны удовлетворять следующим требованиям:
fun equals(other: Any?): Boolean
get
Возвращает значение, соответствующее данному ключу, или null , если такой ключ отсутствует в карте.
operator fun get(key: K): V?
open operator fun get(key: K): V?
hashCode
Возвращает значение хэш-кода для объекта. Общий контракт hashCode:
fun hashCode(): Int
isEmpty
Возвращает true , если карта пуста (не содержит элементов), false в противном случае.
fun isEmpty(): Boolean
putAll
Обновляет эту карту парами ключ/значение из указанной карты from.
fun putAll(from: Map<out K, V>)
remove
Удаляет указанный ключ и соответствующее ему значение из этой карты.
fun remove(key: K): V?
open fun remove(key: K): V?
toString
Возвращает строковое представление объекта.
fun toString(): String
Наследованные функции
isEmpty
open fun isEmpty(): Boolean
Функции расширения
all
Возвращает true если все элементы соответствуют заданному
fun <K, V> Map<out K, V>.all(
predicate: (Entry<K, V>) -> Boolean
): Boolean
any
Возвращает true если в карте есть хотя бы один элемент.
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>>
contains
Проверяет, содержит ли карта указанный ключ.
operator fun <K, V> Map<out K, V>.contains(key: K): Boolean
containsKey
Возвращает true если карта содержит указанный
fun <K> Map<out K, *>.containsKey(key: K): Boolean
containsValue
Возвращает true если карта сопоставляет один или несколько ключей указанному
fun <K, V> Map<K, V>.containsValue(value: V): Boolean
count
Возвращает количество элементов в этой карте.
fun <K, V> Map<out K, V>.count(): Int
Возвращает количество элементов, соответствующих заданному
fun <K, V> Map<out K, V>.count(
predicate: (Entry<K, V>) -> Boolean
): Int
filter
Возвращает новую карту, содержащую все пары ключ-значение, соответствующие заданному
fun <K, V> Map<out K, V>.filter(
predicate: (Entry<K, V>) -> Boolean
): Map<K, V>
filterKeys
Возвращает карту, содержащую все пары ключ-значение с ключами, соответствующими заданному
fun <K, V> Map<out K, V>.filterKeys(
predicate: (K) -> Boolean
): Map<K, V>
filterNot
Возвращает новую карту, содержащую все пары ключ-значение, не соответствующие заданному
fun <K, V> Map<out K, V>.filterNot(
predicate: (Entry<K, V>) -> Boolean
): Map<K, V>
filterNotTo
Добавляет все элементы, не соответствующие заданному .
fun <K, V, M : MutableMap<in K, in V>> Map<out K, V>.filterNotTo( destination: M, predicate: (Entry<K, V>) -> Boolean ): M
filterTo
Добавляет все элементы, соответствующие заданному .
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
Возвращает значение для заданного
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
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
Возвращает наибольшее значение согласно предоставленному компаратору среди всех значений, полученных функцией selector, применённой к каждой записи в карте.
fun <K, V, R> Map<out K, V>.maxOfWith( comparator: Comparator<in R>, selector: (Entry<K, V>) -> R ): R
maxOfWithOrNull
Возвращает наибольшее значение согласно предоставленному компаратору среди всех значений, полученных функцией 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
Возвращает первую запись с наибольшим значением согласно предоставленному компаратору или 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
Возвращает наименьшее значение согласно предоставленному компаратору среди всех значений, полученных функцией selector, применённой к каждой записи в карте.
fun <K, V, R> Map<out K, V>.minOfWith( comparator: Comparator<in R>, selector: (Entry<K, V>) -> R ): R
minOfWithOrNull
Возвращает наименьшее значение согласно предоставленному компаратору среди всех значений, полученных функцией selector, применённой к каждой записи в карте, или 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
Возвращает первый элемент с наименьшим значением в соответствии с предоставленным
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
orEmpty
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
Добавляет все заданные пары в эту изменяемую карту, где первый элемент пары — ключ, а второй — значение.
fun <K, V> MutableMap<in K, in V>.putAll( pairs: Array<out Pair<K, V>>)
Добавляет все элементы из заданного набора в эту изменяемую карту, где первый элемент пары — ключ, а второй — значение.
fun <K, V> MutableMap<in K, in V>.putAll( pairs: Iterable<Pair<K, V>>)
Добавляет все элементы из заданной последовательности в эту изменяемую карту, где первый элемент пары — ключ, а второй — значение.
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?
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>
withDefault
Возвращает оболочку этой неизменяемой карты, имеющей неявное значение по умолчанию, предоставленное указанной функцией defaultValue.
fun <K, V> Map<K, V>.withDefault( defaultValue: (key: K) -> V ): Map<K, V>
Возвращает оболочку этой изменяемой карты, имеющей неявное значение по умолчанию, предоставленное указанной функцией defaultValue.
fun <K, V> MutableMap<K, V>.withDefault( defaultValue: (key: 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/-hash-map/index.html