Spec-Zone.ru › Kotlin 1.4

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.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 для каждой записи исходной карты, в заданный destination.

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 карта является либо 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

Заполняет заданный словарь-назначение записями, ключи которых получены путём применения функции преобразования к каждой записи в этом словаре, а значения — из этого словаря.

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

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

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

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

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

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

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

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

Заполняет заданный словарь-назначение записями, имеющими ключи этого словаря и значениями, полученными путём применения функции преобразования к каждой записи в этом словаре.

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

maxBy

fun <K, V, R : Comparable<R>> Map<out K, V>.maxBy(
    selector: (Entry<K, V>) -> R
): Entry<K, V>?
Требования к платформе и версии: 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

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

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

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

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

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>

Заполняет и возвращает изменяемый массив destination парами ключ-значение из данного массива.

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), Native (1.1) 
abstract class AbstractMutableMap<K, V> : 
    AbstractMap<K, V>, 
    MutableMap<K, V>

© 2010–2020 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