Spec-Zone.ru › Kotlin 1.6

AbstractMutableMap

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

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

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

Параметры

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

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

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

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

<init>

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

<init>()

Свойства

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

entries

abstract val entries: MutableSet<MutableEntry<K, V>>
Требования к платформе и версии: JS (1.0), Native (1.0)

keys

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

open val keys: MutableSet<K>
Требования к платформе и версии:

size

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

values

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

open val values: MutableCollection<V>

Функции

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

clear

Удаляет все элементы из этой карты.

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

containsKey

open fun containsKey(key: K): Boolean
Требования к платформе и версии:

containsValue

open fun containsValue(value: V): Boolean
Требования к платформе и версии:

get

open fun get(key: K): V?
Требования к платформе и версии:

isEmpty

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

put

Связывает указанное значение с указанным ключом в карте.

abstract fun put(key: K, value: V): V?
Требования к платформе и версии: JS (1.0), Native (1.0)

putAll

Обновляет эту карту парами ключ/значение из указанной карты from.

open fun putAll(from: Map<out K, V>)
Требования к платформе и версии: JS (1.0), Native (1.0)

remove

Удаляет указанный ключ и соответствующее ему значение из этой карты.

open fun remove(key: K): V?

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

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

какIterable

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

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

какПоследовательность

Создаёт экземпляр 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>
... (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.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.1), JS (1.1), Native (1.1)

minusAssign

Удаляет запись с заданным ключом из этой изменяемой карты.

operator fun <K, V> MutableMap<K, V>.minusAssign(key: K)

Удаляет все записи, ключи которых содержатся в заданном наборе ключей из этой изменяемой карты.

operator fun <K, V> MutableMap<K, V>.minusAssign(
    keys: Iterable<K>)

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

operator fun <K, V> MutableMap<K, V>.minusAssign(
    keys: Array<out K>)

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

operator fun <K, V> MutableMap<K, V>.minusAssign(
    keys: Sequence<K>)
Требования к платформе и версии: 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

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

plusAssign

Добавляет или заменяет заданную пару в этой изменяемой карте.

operator fun <K, V> MutableMap<in K, in V>.plusAssign(
    pair: Pair<K, V>)

Добавляет или заменяет все пары из заданного набора пар в этой изменяемой карте.

operator fun <K, V> MutableMap<in K, in V>.plusAssign(
    pairs: Iterable<Pair<K, V>>)

Добавляет или заменяет все пары из заданного массива пар в этой изменяемой карте.

operator fun <K, V> MutableMap<in K, in V>.plusAssign(
    pairs: Array<out Pair<K, V>>)

Добавляет или заменяет все пары из заданной последовательности пар в этой изменяемой карте.

operator fun <K, V> MutableMap<in K, in V>.plusAssign(
    pairs: Sequence<Pair<K, V>>)

Добавляет или заменяет все записи из заданной карты в этой изменяемой карте.

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

putAll

Добавляет все заданные пары в эту MutableMap, где первый компонент пары является ключом, а второй — значением.

fun <K, V> MutableMap<in K, in V>.putAll(
    pairs: Array<out Pair<K, V>>)

Добавляет все элементы заданного набора в эту MutableMap, где первый компонент пары является ключом, а второй — значением.

fun <K, V> MutableMap<in K, in V>.putAll(
    pairs: Iterable<Pair<K, V>>)

Добавляет все элементы заданной последовательности в эту MutableMap, где первый компонент пары является ключом, а второй — значением.

fun <K, V> MutableMap<in K, in V>.putAll(
    pairs: Sequence<Pair<K, V>>)
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

remove

Удаляет указанный ключ и соответствующее ему значение из этой карты.

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

set

Позволяет использовать оператор индекса для хранения значений в изменяемой карте.

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

setValue

Хранит значение свойства для данного объекта в этой изменяемой карте.

operator fun <V> MutableMap<in String, in V>.setValue(
    thisRef: Any?, 
    property: KProperty<*>, 
    value: 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
END_OF_DOCUMENT_MARKER
Требования к платформе и версии: 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, 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>

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

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

Наследники

HashMap

Реализация интерфейса MutableMap, основанная на хеш-таблице.

Требования к платформе и версии: Native (1.3)
class HashMap<K, V> : MutableMap<K, V>
Требования к платформе и версии: JVM (1.1)
typealias HashMap<K, V> = HashMap<K, V>
Требования к платформе и версии: JS (1.1)
open class HashMap<K, V> : 
    AbstractMutableMap<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-mutable-map/index.html

Spec-Zone.ru

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