AbstractMap

kotlin-stdlib/kotlin.collections/AbstractMap

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

abstract class AbstractMap<K, out V> : Map<K, V>

Предоставляет базовую реализацию интерфейса Map только для чтения.

Реализация должна определить свойство entries, которое должно возвращать набор записей карты только для чтения.

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

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

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

Наследники

AbstractMutableMap

Конструкторы

AbstractMap

Требования к платформе и версии: Общие

protected constructor()

Свойства

entries

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

abstract val entries: Set<Map.Entry<K, V>>

Возвращает набор Set всех пар ключ/значение в этой карте только для чтения.

keys

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

open override val keys: Set<K>

Возвращает набор Set всех ключей в этой карте только для чтения.

size

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

open override val size: Int

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

values

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

open override val values: Collection<V>

Возвращает коллекцию Collection всех значений в этой карте только для чтения.

Функции

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, который оборачивает исходную карту и при итерации возвращает ее записи.

asSequence

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

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

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

contains

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

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

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

containsKey

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

open override fun containsKey(key: K): Boolean

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

containsKey

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

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

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

containsValue

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

open override 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

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

equals

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

open operator override fun equals(other: Any?): Boolean

Сравнивает эту карту с другим экземпляром на предмет упорядоченного структурного равенства.

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.1)

open operator override 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

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

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

hashCode

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

open override fun hashCode(): Int

Возвращает хеш-код этой карты.

isEmpty

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

open override 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, если эта допускающая значение null карта равна null или пуста.

iterator

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

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

Возвращает Iterator для записей Map.

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 к каждой записи карты.

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 к каждой записи карты, или null, если карта пуста.

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

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

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?

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

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>

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

Требования к платформе и версии: 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>?

Возвращает первую запись с наибольшим значением согласно заданному компаратору или 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>

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

Требования к платформе и версии: 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>?

Возвращает первую запись, для которой функция выбора возвращает наименьшее значение, или 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

Возвращает наименьшее значение среди всех значений, полученных при применении функции выбора к каждой записи в 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?

Возвращает наименьшее значение среди всех значений, полученных при применении функции выбора к каждой записи в 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

Возвращает наименьшее значение согласно заданному компаратору среди всех значений, полученных при применении функции выбора к каждой записи в 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?

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

minus

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

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

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

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

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

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

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

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

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

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>

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

Требования к платформе и версии: 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>?

Возвращает первую запись с наименьшим значением согласно заданному компаратору или 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, если ни одна запись не соответствует заданному предикату.

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 записи из заданного массива пар «ключ-значение» (пар).

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

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

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

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

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 записи из заданной последовательности пар «ключ-значение» (пар).

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 назначения парами «ключ-значение» из заданной 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 определяет равенство и порядок ключей согласно порядку сортировки, заданному указанным компаратором.

toString

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

open override fun toString(): String

Возвращает строковое представление объекта.

withDefault

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

fun <K, V> Map<K, V>.withDefault(defaultValue: (key: K) -> V): Map<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/-abstract-map/index.html