Spec-Zone.ru › Kotlin 1.7

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, которое должно возвращать набор (set) элементов карты для чтения.

Параметры

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)

размер

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

значения

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

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

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

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

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

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

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

operator fun <K, V> Map<out K, V>.get(key: K): V?
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

getOrElse

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

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.3), JS (1.3), Native (1.3)

ifEmpty

Возвращает эту карту, если она не пустая, или результат вызова функции defaultValue, если карта пустая.

fun <M, R> M.ifEmpty(
    defaultValue: () -> R
): R where M : Map<*, *>, M : R
Требования к платформе и версии: 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

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

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

fun <K, V, R : Any> Map<out K, V>.mapNotNull(
    transform: (Entry<K, V>) -> R?
): List<R>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

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
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

mapTo

Применяет заданную функцию transform к каждой записи исходной карты и добавляет результаты в заданный destination.

fun <K, V, R, C : MutableCollection<in R>> Map<out K, V>.mapTo(
    destination: C, 
    transform: (Entry<K, V>) -> R
): C
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

mapValues

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

fun <K, V, R> Map<out K, V>.mapValues(
    transform: (Entry<K, V>) -> R
): Map<K, R>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

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
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

maxByOrNull

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

fun <K, V, R : Comparable<R>> Map<out K, V>.maxByOrNull(
    selector: (Entry<K, V>) -> R
): Entry<K, V>?
Требования к платформе и версии: JVM (1.4), JS (1.4), Native (1.4)

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
Требования к платформе и версии: 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.7), JS (1.7), Native (1.7)

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

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

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

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

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

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

withDefault

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API