Интерфейс ConcurrentNavigableMap<K,V>

Параметры типа:: K — тип ключей, хранящихся в этой карте; V — тип отображаемых значений

Все суперинтерфейсы:: ConcurrentMap<K,V>, Map<K,V>, NavigableMap<K,V>, SequencedMap<K,V>, SortedMap<K,V>

Все известные классы-реализации:: ConcurrentSkipListMap

public interface ConcurrentNavigableMap<K,V> extends ConcurrentMap<K,V>, NavigableMap<K,V>

ConcurrentMap, поддерживающий операции NavigableMap, а также рекурсивно для его навигационных под-карт.

Этот интерфейс является частью Java Collections Framework.

Начиная с:: 1.6

Краткое описание вложенных классов

Вложенные классы/интерфейсы, объявленные в интерфейсе Map

Map.Entry<K,V>

Модификатор и тип	Интерфейс	Описание
`static interface`	`Map.Entry<K,V>`	Запись карты (пара ключ-значение).

Краткое описание методов

Модификатор и тип	Метод	Описание
`NavigableSet<K>`	`descendingKeySet()`	Возвращает представление ключей, содержащихся в этой карте, в обратном порядке в виде `NavigableSet`.
`ConcurrentNavigableMap<K,V>`	`descendingMap()`	Возвращает представление отображений, содержащихся в этой карте, в обратном порядке.
`ConcurrentNavigableMap<K,V>`	`headMap(K toKey)`	Возвращает представление части этой карты, ключи которой строго меньше `toKey`.
`ConcurrentNavigableMap<K,V>`	`headMap(K toKey, boolean inclusive)`	Возвращает представление части этой карты, ключи которой меньше (или равны, если `inclusive` равно true) `toKey`.
`NavigableSet<K>`	`keySet()`	Возвращает представление ключей, содержащихся в этой карте, в виде `NavigableSet`.
`NavigableSet<K>`	`navigableKeySet()`	Возвращает представление ключей, содержащихся в этой карте, в виде `NavigableSet`.
`ConcurrentNavigableMap<K,V>`	`subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)`	Возвращает представление части этой карты, ключи которой находятся в диапазоне от `fromKey` до `toKey`.
`ConcurrentNavigableMap<K,V>`	`subMap(K fromKey, K toKey)`	Возвращает представление части этой карты, ключи которой находятся в диапазоне от `fromKey` включительно до `toKey` не включительно.
`ConcurrentNavigableMap<K,V>`	`tailMap(K fromKey)`	Возвращает представление части этой карты, ключи которой больше или равны `fromKey`.
`ConcurrentNavigableMap<K,V>`	`tailMap(K fromKey, boolean inclusive)`	Возвращает представление части этой карты, ключи которой больше (или равны, если `inclusive` равно true) `fromKey`.

Методы, объявленные в интерфейсе ConcurrentMap

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Модификатор и тип	Метод	Описание
`default V`	`compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)`	Пытается вычислить отображение для указанного ключа и его текущего отображаемого значения либо `null`, если текущее отображение отсутствует (необязательная операция).
`default V`	`computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction)`	Если указанному ключу еще не сопоставлено значение (или ему сопоставлено `null`), пытается вычислить его значение с помощью заданной функции отображения и добавить его в эту карту, если только `null` (необязательная операция).
`default V`	`computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)`	Если для указанного ключа имеется ненулевое значение, пытается вычислить новое отображение по ключу и его текущему отображаемому значению (необязательная операция).
`default void`	`forEach(BiConsumer<? super K, ? super V> action)`	Выполняет заданное действие для каждой записи этой карты, пока не будут обработаны все записи или действие не вызовет исключение.
`default V`	`getOrDefault(Object key, V defaultValue)`	Возвращает значение, сопоставленное с указанным ключом, или `defaultValue`, если в этой карте нет отображения для ключа.
`default V`	`merge(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction)`	Если указанному ключу еще не сопоставлено значение или ему сопоставлено null, сопоставляет его с заданным ненулевым значением (необязательная операция).
`V`	`putIfAbsent(K key, V value)`	Если указанному ключу еще не сопоставлено значение, сопоставляет его с заданным значением.
`boolean`	`remove(Object key, Object value)`	Удаляет запись для ключа только в том случае, если в данный момент ему сопоставлено заданное значение.
`V`	`replace(K key, V value)`	Заменяет запись для ключа только в том случае, если в данный момент ему сопоставлено какое-либо значение.
`boolean`	`replace(K key, V oldValue, V newValue)`	Заменяет запись для ключа только в том случае, если в данный момент ему сопоставлено заданное значение.
`default void`	`replaceAll(BiFunction<? super K, ? super V, ? extends V> function)`	Заменяет значение каждой записи результатом вызова заданной функции для этой записи, пока не будут обработаны все записи или функция не вызовет исключение (необязательная операция).

Методы, объявленные в интерфейсе Map

clear, containsKey, containsValue, equals, get, hashCode, isEmpty, put, putAll, remove, size

Модификатор и тип	Метод	Описание
`void`	`clear()`	Удаляет все отображения из этой карты (необязательная операция).
`boolean`	`containsKey(Object key)`	Возвращает `true`, если эта карта содержит отображение для указанного ключа.
`boolean`	`containsValue(Object value)`	Возвращает `true`, если в этой карте одному или нескольким ключам сопоставлено указанное значение.
`boolean`	`equals(Object o)`	Сравнивает указанный объект с этой картой на предмет равенства.
`V`	`get(Object key)`	Возвращает значение, сопоставленное с указанным ключом, или `null`, если в этой карте нет отображения для ключа.
`int`	`hashCode()`	Возвращает значение хеш-кода этой карты.
`boolean`	`isEmpty()`	Возвращает `true`, если эта карта не содержит сопоставлений ключ-значение.
`V`	`put(K key, V value)`	Сопоставляет указанное значение с указанным ключом в этой карте (необязательная операция).
`void`	`putAll(Map<? extends K, ? extends V> m)`	Копирует все отображения из указанной карты в эту карту (необязательная операция).
`V`	`remove(Object key)`	Удаляет отображение для ключа из этой карты, если оно имеется (необязательная операция).
`int`	`size()`	Возвращает количество сопоставлений ключ-значение в этой карте.

Методы, объявленные в интерфейсе NavigableMap

ceilingEntry, ceilingKey, firstEntry, floorEntry, floorKey, higherEntry, higherKey, lastEntry, lowerEntry, lowerKey, pollFirstEntry, pollLastEntry, reversed

Модификатор и тип	Метод	Описание
`Map.Entry<K,V>`	`ceilingEntry(K key)`	Возвращает сопоставление ключ-значение, связанное с наименьшим ключом, большим или равным заданному, либо `null`, если такого ключа нет.
`K`	`ceilingKey(K key)`	Возвращает наименьший ключ, больший или равный заданному, либо `null`, если такого ключа нет.
`Map.Entry<K,V>`	`firstEntry()`	Возвращает сопоставление ключ-значение, связанное с наименьшим ключом в этой карте, либо `null`, если карта пуста.
`Map.Entry<K,V>`	`floorEntry(K key)`	Возвращает сопоставление ключ-значение, связанное с наибольшим ключом, меньшим или равным заданному, либо `null`, если такого ключа нет.
`K`	`floorKey(K key)`	Возвращает наибольший ключ, меньший или равный заданному, либо `null`, если такого ключа нет.
`Map.Entry<K,V>`	`higherEntry(K key)`	Возвращает сопоставление ключ-значение, связанное с наименьшим ключом, строго большим заданного, либо `null`, если такого ключа нет.
`K`	`higherKey(K key)`	Возвращает наименьший ключ, строго больший заданного, либо `null`, если такого ключа нет.
`Map.Entry<K,V>`	`lastEntry()`	Возвращает сопоставление ключ-значение, связанное с наибольшим ключом в этой карте, либо `null`, если карта пуста.
`Map.Entry<K,V>`	`lowerEntry(K key)`	Возвращает сопоставление ключ-значение, связанное с наибольшим ключом, строго меньшим заданного, либо `null`, если такого ключа нет.
`K`	`lowerKey(K key)`	Возвращает наибольший ключ, строго меньший заданного, либо `null`, если такого ключа нет.
`Map.Entry<K,V>`	`pollFirstEntry()`	Удаляет и возвращает сопоставление ключ-значение, связанное с наименьшим ключом в этой карте, либо `null`, если карта пуста (необязательная операция).
`Map.Entry<K,V>`	`pollLastEntry()`	Удаляет и возвращает сопоставление ключ-значение, связанное с наибольшим ключом в этой карте, либо `null`, если карта пуста (необязательная операция).
`default NavigableMap<K,V>`	`reversed()`	Возвращает представление этой карты с элементами в обратном порядке.

Методы, объявленные в интерфейсе SequencedMap

sequencedEntrySet, sequencedKeySet, sequencedValues

Модификатор и тип	Метод	Описание
`default SequencedSet<Map.Entry<K,V>>`	`sequencedEntrySet()`	Возвращает представление `SequencedSet` `entrySet` этой карты.
`default SequencedSet<K>`	`sequencedKeySet()`	Возвращает представление `SequencedSet` `keySet` этой карты.
`default SequencedCollection<V>`	`sequencedValues()`	Возвращает представление `SequencedCollection` коллекции `values` этой карты.

Методы, объявленные в интерфейсе SortedMap

comparator, entrySet, firstKey, lastKey, putFirst, putLast, values

Модификатор и тип	Метод	Описание
`Comparator<? super K>`	`comparator()`	Возвращает компаратор, используемый для упорядочивания ключей в этой карте, или `null`, если карта использует естественный порядок ключей.
`Set<Map.Entry<K,V>>`	`entrySet()`	Возвращает представление отображений, содержащихся в этой карте, в виде `Set`.
`K`	`firstKey()`	Возвращает первый (наименьший) ключ, находящийся в данный момент в этой карте.
`K`	`lastKey()`	Возвращает последний (наибольший) ключ, находящийся в данный момент в этой карте.
`default V`	`putFirst(K k, V v)`	Вызывает `UnsupportedOperationException`.
`default V`	`putLast(K k, V v)`	Вызывает `UnsupportedOperationException`.
`Collection<V>`	`values()`	Возвращает представление значений, содержащихся в этой карте, в виде `Collection`.

Подробное описание методов

subMap

ConcurrentNavigableMap<K,V> subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)

Описание скопировано из интерфейса: NavigableMap

Возвращает представление части этой карты, ключи которой находятся в диапазоне от fromKey до toKey. Если fromKey и toKey равны, возвращаемая карта пуста, если только fromInclusive и toInclusive не равны true одновременно. Возвращаемая карта связана с этой картой, поэтому изменения в возвращаемой карте отражаются в этой карте, и наоборот. Возвращаемая карта поддерживает все необязательные операции с картами, поддерживаемые этой картой.

При попытке вставить ключ вне диапазона возвращаемая карта выбросит IllegalArgumentException; то же произойдет при попытке создать подмножество карты, одна из конечных точек которого находится вне этого диапазона.

Указано в:: subMap в интерфейсе NavigableMap<K,V>
Параметры:: fromKey — нижняя конечная точка ключей в возвращаемой карте; fromInclusive — true, если нижнюю конечную точку следует включить в возвращаемое представление; toKey — верхняя конечная точка ключей в возвращаемой карте; toInclusive — true, если верхнюю конечную точку следует включить в возвращаемое представление
Возвращает:: представление части этой карты, ключи которой находятся в диапазоне от fromKey до toKey
Исключения:: ClassCastException — если fromKey и toKey нельзя сравнить друг с другом с помощью компаратора этой карты (или, если у карты нет компаратора, с помощью естественного порядка). Реализации могут выбрасывать это исключение, но не обязаны это делать, если fromKey или toKey нельзя сравнить с ключами, содержащимися в карте в данный момент.; NullPointerException — если fromKey или toKey равно null, а эта карта не допускает null-ключи; IllegalArgumentException — если fromKey больше toKey; или если сама эта карта имеет ограниченный диапазон, а fromKey или toKey находится за его пределами

headMap

ConcurrentNavigableMap<K,V> headMap(K toKey, boolean inclusive)

Описание скопировано из интерфейса: NavigableMap

Возвращает представление части этой карты, ключи которой меньше (или равны, если inclusive равно true) toKey. Возвращаемая карта связана с этой картой, поэтому изменения в возвращаемой карте отражаются в этой карте, и наоборот. Возвращаемая карта поддерживает все необязательные операции с картами, поддерживаемые этой картой.

При попытке вставить ключ вне диапазона возвращаемая карта выбросит IllegalArgumentException.

Указано в:: headMap в интерфейсе NavigableMap<K,V>
Параметры:: toKey — верхняя конечная точка ключей в возвращаемой карте; inclusive — true, если верхнюю конечную точку следует включить в возвращаемое представление
Возвращает:: представление части этой карты, ключи которой меньше (или равны, если inclusive равно true) toKey
Исключения:: ClassCastException — если toKey несовместим с компаратором этой карты (или, если у карты нет компаратора, если toKey не реализует Comparable). Реализации могут выбрасывать это исключение, но не обязаны это делать, если toKey нельзя сравнить с ключами, содержащимися в карте в данный момент.; NullPointerException — если toKey равно null, а эта карта не допускает null-ключи; IllegalArgumentException — если сама эта карта имеет ограниченный диапазон, а toKey находится за его пределами

tailMap

ConcurrentNavigableMap<K,V> tailMap(K fromKey, boolean inclusive)

Описание скопировано из интерфейса: NavigableMap

Возвращает представление части этой карты, ключи которой больше (или равны, если inclusive равно true) fromKey. Возвращаемая карта связана с этой картой, поэтому изменения в возвращаемой карте отражаются в этой карте, и наоборот. Возвращаемая карта поддерживает все необязательные операции с картами, поддерживаемые этой картой.

При попытке вставить ключ вне диапазона возвращаемая карта выбросит IllegalArgumentException.

Указано в:: tailMap в интерфейсе NavigableMap<K,V>
Параметры:: fromKey — нижняя конечная точка ключей в возвращаемой карте; inclusive — true, если нижнюю конечную точку следует включить в возвращаемое представление
Возвращает:: представление части этой карты, ключи которой больше (или равны, если inclusive равно true) fromKey
Исключения:: ClassCastException — если fromKey несовместим с компаратором этой карты (или, если у карты нет компаратора, если fromKey не реализует Comparable). Реализации могут выбрасывать это исключение, но не обязаны это делать, если fromKey нельзя сравнить с ключами, содержащимися в карте в данный момент.; NullPointerException — если fromKey равно null, а эта карта не допускает null-ключи; IllegalArgumentException — если сама эта карта имеет ограниченный диапазон, а fromKey находится за его пределами

subMap

ConcurrentNavigableMap<K,V> subMap(K fromKey, K toKey)

Описание скопировано из интерфейса: NavigableMap

Возвращает представление части этой карты, ключи которой находятся в диапазоне от fromKey включительно до toKey исключительно. (Если fromKey и toKey равны, возвращаемая карта пуста.) Возвращаемая карта связана с этой картой, поэтому изменения в возвращаемой карте отражаются в этой карте, и наоборот. Возвращаемая карта поддерживает все необязательные операции с картами, поддерживаемые этой картой.

При попытке вставить ключ вне диапазона возвращаемая карта выбросит IllegalArgumentException.

Эквивалентно subMap(fromKey, true, toKey, false).

Указано в:: subMap в интерфейсе NavigableMap<K,V>
Указано в:: subMap в интерфейсе SortedMap<K,V>
Параметры:: fromKey — нижняя конечная точка ключей в возвращаемой карте (включительно); toKey — верхняя конечная точка ключей в возвращаемой карте (исключительно)
Возвращает:: представление части этой карты, ключи которой находятся в диапазоне от fromKey включительно до toKey исключительно
Исключения:: ClassCastException — если fromKey и toKey нельзя сравнить друг с другом с помощью компаратора этой карты (или, если у карты нет компаратора, с помощью естественного порядка). Реализации могут выбрасывать это исключение, но не обязаны это делать, если fromKey или toKey нельзя сравнить с ключами, содержащимися в карте в данный момент.; NullPointerException — если fromKey или toKey равно null, а эта карта не допускает null-ключи; IllegalArgumentException — если fromKey больше toKey; или если сама эта карта имеет ограниченный диапазон, а fromKey или toKey находится за его пределами

headMap

ConcurrentNavigableMap<K,V> headMap(K toKey)

Описание скопировано из интерфейса: NavigableMap

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

При попытке вставить ключ вне диапазона возвращаемая карта выбросит IllegalArgumentException.

Эквивалентно headMap(toKey, false).

Указано в:: headMap в интерфейсе NavigableMap<K,V>
Указано в:: headMap в интерфейсе SortedMap<K,V>
Параметры:: toKey — верхняя конечная точка ключей в возвращаемой карте (исключительно)
Возвращает:: представление части этой карты, ключи которой строго меньше toKey
Исключения:: ClassCastException — если toKey несовместим с компаратором этой карты (или, если у карты нет компаратора, если toKey не реализует Comparable). Реализации могут выбрасывать это исключение, но не обязаны это делать, если toKey нельзя сравнить с ключами, содержащимися в карте в данный момент.; NullPointerException — если toKey равно null, а эта карта не допускает null-ключи; IllegalArgumentException — если сама эта карта имеет ограниченный диапазон, а toKey находится за его пределами

tailMap

ConcurrentNavigableMap<K,V> tailMap(K fromKey)

Описание скопировано из интерфейса: NavigableMap

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

При попытке вставить ключ вне диапазона возвращаемая карта выбросит IllegalArgumentException.

Эквивалентно tailMap(fromKey, true).

Указано в:: tailMap в интерфейсе NavigableMap<K,V>
Указано в:: tailMap в интерфейсе SortedMap<K,V>
Параметры:: fromKey — нижняя конечная точка ключей в возвращаемой карте (включительно)
Возвращает:: представление части этой карты, ключи которой больше или равны fromKey
Исключения:: ClassCastException — если fromKey несовместим с компаратором этой карты (или, если у карты нет компаратора, если fromKey не реализует Comparable). Реализации могут выбрасывать это исключение, но не обязаны это делать, если fromKey нельзя сравнить с ключами, содержащимися в карте в данный момент.; NullPointerException — если fromKey равно null, а эта карта не допускает null-ключи; IllegalArgumentException — если сама эта карта имеет ограниченный диапазон, а fromKey находится за его пределами

descendingMap

ConcurrentNavigableMap<K,V> descendingMap()

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

Порядок элементов возвращаемой карты эквивалентен порядку, задаваемому Collections.reverseOrder(comparator()). Выражение m.descendingMap().descendingMap() возвращает представление m, по существу эквивалентное m.

Указано в:: descendingMap в интерфейсе NavigableMap<K,V>
Возвращает:: представление этой карты в обратном порядке

navigableKeySet

NavigableSet<K> navigableKeySet()

Возвращает представление в виде NavigableSet ключей, содержащихся в этой карте. Итератор множества возвращает ключи в порядке возрастания. Множество связано с картой, поэтому изменения в карте отражаются в множестве, и наоборот. Множество поддерживает удаление элементов, удаляющее соответствующее отображение из карты, с помощью операций Iterator.remove, Set.remove, removeAll, retainAll и clear. Операции add и addAll не поддерживаются.

Итераторы и сплитераторы представления слабо согласованы.

Указано в:: navigableKeySet в интерфейсе NavigableMap<K,V>
Возвращает:: представление ключей этой карты в виде навигируемого множества

keySet

NavigableSet<K> keySet()

Итераторы и сплитераторы представления слабо согласованы.

Этот метод эквивалентен методу navigableKeySet.

Указано в:: keySet в интерфейсе Map<K,V>
Указано в:: keySet в интерфейсе SortedMap<K,V>
Возвращает:: представление ключей этой карты в виде навигируемого множества

descendingKeySet

NavigableSet<K> descendingKeySet()

Возвращает представление ключей, содержащихся в этой карте, в виде NavigableSet, упорядоченного в обратном порядке. Итератор множества возвращает ключи в порядке убывания. Множество связано с картой, поэтому изменения в карте отражаются в множестве, и наоборот. Множество поддерживает удаление элементов, удаляющее соответствующее отображение из карты, с помощью операций Iterator.remove, Set.remove, removeAll, retainAll и clear. Операции add и addAll не поддерживаются.

Итераторы и сплитераторы представления слабо согласованы.

Указано в:: descendingKeySet в интерфейсе NavigableMap<K,V>
Возвращает:: представление ключей этой карты в виде навигируемого множества в обратном порядке

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.