Карта

kotlin-stdlib / kotlin.collections / Map

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

interface Map<K, out V>

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

Параметры

K - тип ключей карты. Карта инвариантна по типу ключа, так как она может принимать ключ в качестве параметра (например, для containsKey) и возвращать его в наборе keys.

V - тип значений карты. Карта ковариативна по типу значения.

Типы

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

Entry

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

interface Entry<out K, out V>

Свойства

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

entries

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

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

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

keys

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

abstract val keys: Set<K>

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

размер

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

abstract val size: Int

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

значения

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

abstract val values: Collection<V>

Функции

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

содержит ключ

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

abstract fun containsKey(key: K): Boolean

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

содержит значение

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

abstract fun containsValue(value: V): Boolean

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

получить

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

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

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

получить или по умолчанию

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

open fun getOrDefault(key: K, defaultValue: V): V

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

пустая

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

abstract fun isEmpty(): Boolean

Расширяющие функции

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

все

Возвращает true если все записи соответствуют заданному

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

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

любая

Возвращает 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

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

asIterable

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

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

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

asSequence

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

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

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

содержит

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

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

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

содержит-ключ

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

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

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

содержит-значение

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

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

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

количество

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

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

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

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

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

фильтр

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

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

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

фильтр-ключей

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

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

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

фильтр-не

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

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

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

фильтр-не-в

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

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

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

фильтр-в

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

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

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

filterValues

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

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

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

firstNotNullOf

Возвращает первое не-null значение, полученное функцией исключение NoSuchElementException, если не было получено не-null значение.

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

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

firstNotNullOfOrNull

Возвращает первое не-null значение, полученное функцией

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

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

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>

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

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

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

forEach

Выполняет заданное

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

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

get

Возвращает значение, соответствующее заданному

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

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

getOrDefault

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

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

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

getOrElse

Возвращает значение для заданного .

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

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

getValue

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

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

Возвращает значение для заданного

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

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

isNotEmpty

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

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

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

isNullOrEmpty

Возвращает true , если эта карта может быть null или пуста.

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

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

iterator

Возвращает итератор по парам в карте Map.

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

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

map

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

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

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

mapKeys

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

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

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

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

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

mapNotNull

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

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

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

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?

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

maxOfWith

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

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

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

maxOfWithOrNull

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

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

maxWith

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

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

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

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

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

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

maxWithOrNull

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

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

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

minByOrNull

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

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

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

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

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

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?

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

minOfWith

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

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

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

minOfWithOrNull

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

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

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

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>

minWith

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

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

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

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

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

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

minWithOrNull

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

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

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

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

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

onEach

Выполняет заданное

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

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

onEachIndexed

Выполняет заданное

fun <K, V, M : Map<out K, V>> M.onEachIndexed(
    action: (index: Int, Entry<K, V>) -> Unit
): M

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

orEmpty

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

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

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

plus

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

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

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

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

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

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

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

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>

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

toList

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

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

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

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

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

toMutableMap

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

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

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

toProperties

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

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

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

toSortedMap

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

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>

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

withDefault

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

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

Наследники

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

AbstractMap

Предоставляет скелетное реализацию интерфейса Map для неизменяемых карт.

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

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

MutableMap

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

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

© 2010–2023 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/-map/index.html