AbstractMap

kotlin-stdlib / kotlin.collections / AbstractMap

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

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

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

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

Параметры

K - тип ключей карты. Карта инвариантна в отношении типа ключа.

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

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

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

<init>

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

AbstractMap()

Свойства

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

keys

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

open val keys: Set<K>

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

size

open val size: Int

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

values

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

open val values: Collection<V>

Функции

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

containsKey

open fun containsKey(key: K): Boolean

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

containsValue

open fun containsValue(value: V): Boolean

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

equals

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

open fun equals(other: Any?): Boolean

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

get

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

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

hashCode

Возвращает значение хэш-кода для этой карты.

open fun hashCode(): Int

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

isEmpty

open fun isEmpty(): Boolean

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

toString

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

open fun toString(): String

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

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

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

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

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

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>

... (rest of the translated HTML)

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

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

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?

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

maxWith

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.0), JS (1.0), Native (1.0)

minBy

fun <K, V, R : Comparable<R>> Map<out K, V>.minBy(
    selector: (Entry<K, V>) -> R
): 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>

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

minWith

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

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

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

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

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>

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

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

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

Заполняет и возвращает mutable map `destination` парами ключ-значение из заданного map.

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

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

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

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

withDefault

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

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

abstract class AbstractMutableMap<K, V> : 
    MutableMap<K, V>, 
    AbstractMap<K, V>

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

abstract class AbstractMutableMap<K, V> : 
    AbstractMap<K, V>, 
    MutableMap<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/-abstract-map/index.html