Класс TreeMap<K,V>

public class TreeMap<K,V>
extends AbstractMap<K,V>
implements NavigableMap<K,V>, Cloneable, Serializable

Реализация NavigableMap на основе красно-черного дерева. Карта отсортирована в соответствии с естественным порядком своих ключей или с помощью Comparator, предоставленного во время создания карты, в зависимости от используемого конструктора.

Эта реализация гарантирует время выполнения log(n) для операций containsKey, get, put и remove. Алгоритмы являются адаптациями алгоритмов из книги Кормена, Лейзерсона и Ривеста «Введение в алгоритмы».

Обратите внимание, что порядок, поддерживаемый картой дерева, как и любой отсортированной картой, и независимо от того, предоставлен ли явный компаратор, должен быть совместим с equals, если эта отсортированная карта должна корректно реализовывать интерфейс Map. (См. Comparable или Comparator для точного определения совместимости с equals.) Это связано с тем, что интерфейс Map определен в терминах операции equals, но отсортированная карта выполняет все сравнения ключей с помощью своего метода compareTo (или compare). Таким образом, два ключа, считающиеся равными этим методом, с точки зрения отсортированной карты, равны. Поведение отсортированной карты определено даже если её порядок несовместим с equals; оно просто не соответствует общему соглашению интерфейса Map.

Обратите внимание, что эта реализация не синхронизирована. Если несколько потоков одновременно обращаются к карте, и по крайней мере один из потоков изменяет структуру карты, она должна быть синхронизирована внешне. (Структурная модификация — это любая операция, добавляющая или удаляющая одну или несколько пар «ключ-значение»; простое изменение значения, связанного с существующим ключом, не является структурной модификацией.) Обычно это достигается синхронизацией на некотором объекте, естественным образом инкапсулирующем карту. Если такого объекта нет, карта должна быть «оборачена» с помощью метода Collections.synchronizedSortedMap. Это лучше всего сделать во время создания, чтобы предотвратить случайный несинхронизированный доступ к карте:

SortedMap m = Collections.synchronizedSortedMap(new TreeMap(...));

Итераторы, возвращаемые методом iterator коллекций, возвращаемых всеми методами «представления коллекций» этого класса, являются быстродействующими: если карта структурно изменяется в любое время после создания итератора, любым способом, кроме метода remove самого итератора, итератор сгенерирует исключение ConcurrentModificationException. Таким образом, перед лицом одновременной модификации итератор быстро и четко завершает работу, а не рискует произвольным, непредсказуемым поведением в неопределенное время в будущем.

Обратите внимание, что гарантировать быстродействие итераторов невозможно, поскольку в общем случае невозможно дать какие-либо гарантии в условиях несинхронизированной одновременной модификации. Быстродействующие итераторы генерируют исключения ConcurrentModificationException в лучшем случае. Поэтому неправильно писать программу, которая полагалась бы на это исключение для своей корректности: быстродействие итераторов должно использоваться только для обнаружения ошибок.

Все Map.Entry пары, возвращаемые методами этого класса и его представлений, представляют собой снимки сопоставлений на момент их создания. Они не поддерживают метод Entry.setValue. (Однако обратите внимание, что изменить сопоставления в связанной карте можно с помощью put.)

Этот класс является частью Java Collections Framework.

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

TreeMap

public TreeMap()

Создаёт новую пустую карту дерева, используя естественный порядок её ключей. Все ключи, вставленные в карту, должны реализовывать интерфейс Comparable. Кроме того, все такие ключи должны быть взаимно сравнимы: k1.compareTo(k2) не должен генерировать ClassCastException для любых ключей k1 и k2 в карте. Если пользователь пытается поместить ключ в карту, нарушающий это ограничение (например, пользователь пытается поместить строковый ключ в карту, ключами которой являются целые числа), вызов put(Object key, Object value) сгенерирует ClassCastException.

TreeMap

public TreeMap(Comparator<? super K> comparator)

Создаёт новую пустую карту дерева, упорядоченную в соответствии с заданным компаратором. Все ключи, вставленные в карту, должны быть взаимно сравнимы с помощью заданного компаратора: comparator.compare(k1, k2) не должен генерировать ClassCastException для любых ключей k1 и k2 в карте. Если пользователь пытается поместить ключ в карту, нарушающий это ограничение, вызов put(Object key, Object value) сгенерирует ClassCastException.

Параметры:

comparator - компаратор, который будет использоваться для упорядочения этой карты. Если null, будет использоваться естественный порядок ключей.

TreeMap

public TreeMap(Map<? extends K,? extends V> m)

Создаёт новую карту дерева, содержащую те же отображения, что и заданная карта, упорядоченную в соответствии с естественным порядком её ключей. Все ключи, вставленные в новую карту, должны реализовывать интерфейс Comparable. Кроме того, все такие ключи должны быть взаимно сравнимы: k1.compareTo(k2) не должен генерировать ClassCastException для любых ключей k1 и k2 в карте. Этот метод работает за время n*log(n).

Параметры:

m - карта, отображения которой должны быть помещены в эту карту

Исключения:

ClassCastException - если ключи в m не являются Comparable или не являются взаимно сравнимыми

NullPointerException - если указанная карта равна null

TreeMap

public TreeMap(SortedMap<K,? extends V> m)

Создаёт новую карту дерева, содержащую те же отображения и использующую тот же порядок, что и указанная отсортированная карта. Этот метод работает за линейное время.

Параметры:

m - отсортированная карта, отображения которой должны быть помещены в эту карту, и чей компаратор должен использоваться для сортировки этой карты

Исключения:

NullPointerException - если указанная карта равна null

Методы

size

public int size()

Возвращает количество пар ключ-значение в этой карте.

Определено в:

size в интерфейсе Map<K,V>

Переопределяет:

size в классе AbstractMap<K,V>

Возвращает:

количество пар ключ-значение в этой карте

containsKey

public boolean containsKey(Object key)

Возвращает true , если эта карта содержит отображение для указанного ключа.

Определено в:

containsKey в интерфейсе Map<K,V>

Переопределяет:

containsKey в классе AbstractMap<K,V>

Параметры:

key - ключ, чьё присутствие в этой карте необходимо проверить

Возвращает:

true , если эта карта содержит отображение для указанного ключа

Исключения:

ClassCastException - если указанный ключ не может быть сравнен с ключами, которые в данный момент находятся в карте

NullPointerException - если указанный ключ равен null, и эта карта использует естественный порядок, или её компаратор не допускает null-ключей

containsValue

public boolean containsValue(Object value)

Возвращает true , если эта карта отображает один или несколько ключей на указанное значение. Более формально, возвращает true тогда и только тогда, когда эта карта содержит, по крайней мере, одно отображение на значение v такое, что (value==null ? v==null : value.equals(v)). Эта операция, вероятно, потребует времени, линейного относительно размера карты, для большинства реализаций.

Определено в:

containsValue в интерфейсе Map<K,V>

Переопределяет:

containsValue в классе AbstractMap<K,V>

Параметры:

value - значение, чьё присутствие в этой карте необходимо проверить

Возвращает:

true , если отображение на value существует; false в противном случае

С:

1.2

get

public V get(Object key)

Определено в:

get в интерфейсе Map<K,V>

Переопределяет:

get в классе AbstractMap<K,V>

Параметры:

key - ключ, чьё связанное значение должно быть возвращено

Возвращает:

значение, которому соответствует указанный ключ, или null , если эта карта не содержит отображения для ключа

Исключения:

ClassCastException - если указанный ключ не может быть сравнен с ключами, которые в данный момент находятся в карте

NullPointerException - если указанный ключ равен null, и эта карта использует естественный порядок, или её компаратор не допускает null-ключей

comparator

public Comparator<? super K> comparator()

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

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

Определено в:

comparator в интерфейсе SortedMap<K,V>

Возвращает:

компаратор, используемый для упорядочивания ключей в этой карте, или null , если эта карта использует естественный порядок ключей

firstKey

public K firstKey()

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

Возвращает первый (наименьший) ключ, который в данный момент находится в этой карте.

Определено в:

firstKey в интерфейсе SortedMap<K,V>

Возвращает:

первый (наименьший) ключ, который в данный момент находится в этой карте

Исключения:

NoSuchElementException - если эта карта пуста

lastKey

public K lastKey()

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

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

Определено в:

lastKey в интерфейсе SortedMap<K,V>

Возвращает:

последний (наибольший) ключ, который в данный момент находится в этой карте

Исключения:

NoSuchElementException - если эта карта пуста

putAll

public void putAll(Map<? extends K,? extends V> map)

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

Определено в:

putAll в интерфейсе Map<K,V>

Переопределяет:

putAll в классе AbstractMap<K,V>

Параметры:

map - отображения, которые должны быть сохранены в этой карте

Исключения:

ClassCastException - если класс ключа или значения в указанной карте препятствует его хранению в этой карте

NullPointerException - если указанная карта равна null, или указанная карта содержит null-ключ, а эта карта не допускает null-ключей

put

public V put(K key,
             V value)

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

Определено в:

put в интерфейсе Map<K,V>

Переопределяет:

put в классе AbstractMap<K,V>

Параметры:

key - ключ, с которым должно быть связано указанное значение

value - значение, которое должно быть связано с указанным ключом

Возвращает:

предыдущее значение, связанное с key, или null , если для key не было отображения. (Возврат значения null также может указывать, что карта ранее связывала null со значением key.)

Исключения:

ClassCastException - если указанный ключ не может быть сравнен с ключами, которые в данный момент находятся в карте

NullPointerException - если указанный ключ равен null, и эта карта использует естественный порядок, или её компаратор не допускает null-ключей

remove

public V remove(Object key)

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

Определено в:

remove в интерфейсе Map<K,V>

Переопределяет:

remove в классе AbstractMap<K,V>

Параметры:

key - ключ, отображение которого должно быть удалено

Возвращает:

предыдущее значение, связанное с key, или null , если для key не было отображения. (Возврат значения null также может указывать, что карта ранее связывала null со значением key.)

Исключения:

ClassCastException - если указанный ключ не может быть сравнен с ключами, которые в данный момент находятся в карте

NullPointerException - если указанный ключ равен null, и эта карта использует естественный порядок, или её компаратор не допускает null-ключей

clear

public void clear()

Удаляет все отображения из этой карты. Карта будет пустой после возврата этого вызова.

Определено в:

clear в интерфейсе Map<K,V>

Переопределяет:

clear в классе AbstractMap<K,V>

clone

public Object clone()

Возвращает неглубокую копию этого экземпляра TreeMap. (Сами ключи и значения не клонируются.)

Переопределяет:

clone в классе AbstractMap<K,V>

Возвращает:

неглубокая копия этой карты

См. также:

Cloneable

firstEntry

public Map.Entry<K,V> firstEntry()

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

Возвращает сопоставление ключ-значение, связанное с наименьшим ключом в этой карте, или null, если карта пуста.

Указано в:

firstEntry в интерфейсе NavigableMap<K,V>

Возвращает:

запись с наименьшим ключом или null, если эта карта пуста

С версии:

1.6

lastEntry

public Map.Entry<K,V> lastEntry()

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

Возвращает сопоставление ключ-значение, связанное с наибольшим ключом в этой карте, или null, если карта пуста.

Указано в:

lastEntry в интерфейсе NavigableMap<K,V>

Возвращает:

запись с наибольшим ключом или null, если эта карта пуста

С версии:

1.6

pollFirstEntry

public Map.Entry<K,V> pollFirstEntry()

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

Удаляет и возвращает сопоставление ключ-значение, связанное с наименьшим ключом в этой карте, или null, если карта пуста.

Указано в:

pollFirstEntry в интерфейсе NavigableMap<K,V>

Возвращает:

удаленную первую запись этой карты или null, если эта карта пуста

С версии:

1.6

pollLastEntry

public Map.Entry<K,V> pollLastEntry()

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

Удаляет и возвращает сопоставление ключ-значение, связанное с наибольшим ключом в этой карте, или null, если карта пуста.

Указано в:

pollLastEntry в интерфейсе NavigableMap<K,V>

Возвращает:

удаленную последнюю запись этой карты или null, если эта карта пуста

С версии:

1.6

lowerEntry

public Map.Entry<K,V> lowerEntry(K key)

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

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

Указано в:

lowerEntry в интерфейсе NavigableMap<K,V>

Параметры:

key - ключ

Возвращает:

запись с наибольшим ключом, меньшим чем key, или null, если такого ключа нет

Исключения:

ClassCastException - если указанный ключ не может быть сравнен с ключами, которые в данный момент находятся в карте

NullPointerException - если указанный ключ равен null, и эта карта использует естественный порядок, или её компаратор не допускает ключей со значением null

С версии:

1.6

lowerKey

public K lowerKey(K key)

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

Возвращает наибольший ключ, строго меньший, чем заданный ключ, или null, если такого ключа нет.

Указано в:

lowerKey в интерфейсе NavigableMap<K,V>

Параметры:

key - ключ

Возвращает:

наибольший ключ, меньший чем key, или null, если такого ключа нет

Исключения:

ClassCastException - если указанный ключ не может быть сравнен с ключами, которые в данный момент находятся в карте

NullPointerException - если указанный ключ равен null, и эта карта использует естественный порядок, или её компаратор не допускает ключей со значением null

С версии:

1.6

floorEntry

public Map.Entry<K,V> floorEntry(K key)

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

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

Указано в:

floorEntry в интерфейсе NavigableMap<K,V>

Параметры:

key - ключ

Возвращает:

запись с наибольшим ключом, меньшим или равным key, или null, если такого ключа нет

Исключения:

ClassCastException - если указанный ключ не может быть сравнен с ключами, которые в данный момент находятся в карте

NullPointerException - если указанный ключ равен null, и эта карта использует естественный порядок, или её компаратор не допускает ключей со значением null

С версии:

1.6

floorKey

public K floorKey(K key)

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

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

Указано в:

floorKey в интерфейсе NavigableMap<K,V>

Параметры:

key - ключ

Возвращает:

наибольший ключ, меньший или равный key, или null, если такого ключа нет

Исключения:

ClassCastException - если указанный ключ не может быть сравнен с ключами, которые в данный момент находятся в карте

NullPointerException - если указанный ключ равен null, и эта карта использует естественный порядок, или её компаратор не допускает ключей со значением null

С версии:

1.6

ceilingEntry

public Map.Entry<K,V> ceilingEntry(K key)

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

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

Указано в:

ceilingEntry в интерфейсе NavigableMap<K,V>

Параметры:

key - ключ

Возвращает:

запись с наименьшим ключом, большим или равным key, или null, если такого ключа нет

Исключения:

ClassCastException - если указанный ключ не может быть сравнен с ключами, которые в данный момент находятся в карте

NullPointerException - если указанный ключ равен null, и эта карта использует естественный порядок, или её компаратор не допускает ключей со значением null

С версии:

1.6

ceilingKey

public K ceilingKey(K key)

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

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

Указано в:

ceilingKey в интерфейсе NavigableMap<K,V>

Параметры:

key - ключ

Возвращает:

наименьший ключ, больший или равный key, или null, если такого ключа нет

Исключения:

ClassCastException - если указанный ключ не может быть сравнен с ключами, которые в данный момент находятся в карте

NullPointerException - если указанный ключ равен null, и эта карта использует естественный порядок, или её компаратор не допускает ключей со значением null

С версии:

1.6

higherEntry

public Map.Entry<K,V> higherEntry(K key)

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

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

Указано в:

higherEntry в интерфейсе NavigableMap<K,V>

Параметры:

key - ключ

Возвращает:

запись с наименьшим ключом, большим чем key, или null, если такого ключа нет

Исключения:

ClassCastException - если указанный ключ не может быть сравнен с ключами, которые в данный момент находятся в карте

NullPointerException - если указанный ключ равен null, и эта карта использует естественный порядок, или её компаратор не допускает ключей со значением null

С версии:

1.6

higherKey

public K higherKey(K key)

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

Возвращает наименьший ключ, строго больший, чем заданный ключ, или null, если такого ключа нет.

Указано в:

higherKey в интерфейсе NavigableMap<K,V>

Параметры:

key - ключ

Возвращает:

наименьший ключ, больший чем key, или null, если такого ключа нет

Исключения:

ClassCastException - если указанный ключ не может быть сравнен с ключами, которые в данный момент находятся в карте

NullPointerException - если указанный ключ равен null, и эта карта использует естественный порядок, или её компаратор не допускает ключей со значением null

С версии:

1.6

keySet

public Set<K> keySet()

Указано в:

keySet в интерфейсе Map<K,V>

Указано в:

keySet в интерфейсе SortedMap<K,V>

Переопределяет:

keySet в классе AbstractMap<K,V>

Возвращает:

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

navigableKeySet

public NavigableSet<K> navigableKeySet()

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

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

Указано:

navigableKeySet в интерфейсе NavigableMap<K,V>

Возвращает:

представление навигационного набора ключей в этой карте

С:

1.6

descendingKeySet

public NavigableSet<K> descendingKeySet()

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

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

Указано:

descendingKeySet в интерфейсе NavigableMap<K,V>

Возвращает:

представление навигационного набора ключей в этой карте в обратном порядке

С:

1.6

values

public Collection<V> values()

Указано:

values в интерфейсе Map<K,V>

Указано:

values в интерфейсе SortedMap<K,V>

Переопределяет:

values в классе AbstractMap<K,V>

Возвращает:

представление коллекции значений, содержащихся в этой карте

entrySet

public Set<Map.Entry<K,V>> entrySet()

Указано:

entrySet в интерфейсе Map<K,V>

Указано:

entrySet в интерфейсе SortedMap<K,V>

Указано:

entrySet в классе AbstractMap<K,V>

Возвращает:

представление набора отображений, содержащихся в этой карте

descendingMap

public NavigableMap<K,V> descendingMap()

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

Указано:

descendingMap в интерфейсе NavigableMap<K,V>

Возвращает:

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

С:

1.6

subMap

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

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

Указано:

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 находятся за пределами границ диапазона

С:

1.6

headMap

public NavigableMap<K,V> headMap(K toKey,
                                 boolean inclusive)

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

Указано:

headMap в интерфейсе NavigableMap<K,V>

Параметры:

toKey - верхняя граница ключей в возвращаемой карте

inclusive - true, если верхняя граница должна включаться в возвращаемое представление

Возвращает:

представление части этой карты, ключи которой меньше (или равны, если inclusive true) toKey

Исключения:

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

NullPointerException - если toKey равно null, и эта карта использует естественный порядок, или ее компаратор не допускает null-ключей

IllegalArgumentException - если у этой карты есть ограниченный диапазон, и toKey находится за пределами границ диапазона

С:

1.6

tailMap

public NavigableMap<K,V> tailMap(K fromKey,
                                 boolean inclusive)

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

Указано в:

tailMap в интерфейсе NavigableMap<K,V>

Параметры:

fromKey - нижняя граница ключей в возвращаемой карте

inclusive - true, если нижняя граница должна быть включена в возвращаемый вид

Возвращает:

вид части этой карты, ключи которой больше (или равны, если inclusive истинно) fromKey

Выбрасывает:

ClassCastException - если fromKey не совместим с компаратором этой карты (или, если у карты нет компаратора, если fromKey не реализует Comparable). Реализации могут, но не обязаны, выбрасывать это исключение, если fromKey нельзя сравнить с ключами, которые в настоящее время находятся в карте.

NullPointerException - если fromKey равно null и эта карта использует естественный порядок сортировки, или её компаратор не допускает null-ключей

IllegalArgumentException - если у этой карты есть ограниченный диапазон, и fromKey выходит за пределы границ диапазона

С:

1.6

subMap

public SortedMap<K,V> subMap(K fromKey,
                             K toKey)

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

Указано в:

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

public SortedMap<K,V> headMap(K toKey)

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

Указано в:

headMap в интерфейсе NavigableMap<K,V>

Указано в:

headMap в интерфейсе SortedMap<K,V>

Параметры:

toKey - верхняя граница (не включая) ключей в возвращаемой карте

Возвращает:

представление части этой карты, ключи которой строго меньше toKey

Выбрасывает:

ClassCastException - если toKey не совместим с компаратором этой карты (или, если у карты нет компаратора, если toKey не реализует Comparable). Реализации могут, но не обязаны, выбрасывать это исключение, если toKey нельзя сравнить с ключами, которые в настоящее время находятся в карте.

NullPointerException - если toKey равно null и эта карта использует естественный порядок сортировки, или её компаратор не допускает null-ключей

IllegalArgumentException - если у этой карты есть ограниченный диапазон, и toKey выходит за пределы границ диапазона

tailMap

public SortedMap<K,V> tailMap(K fromKey)

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

Указано в:

tailMap в интерфейсе NavigableMap<K,V>

Указано в:

tailMap в интерфейсе SortedMap<K,V>

Параметры:

fromKey - нижняя граница (включая) ключей в возвращаемой карте

Возвращает:

представление части этой карты, ключи которой больше или равны fromKey

Выбрасывает:

ClassCastException - если fromKey не совместим с компаратором этой карты (или, если у карты нет компаратора, если fromKey не реализует Comparable). Реализации могут, но не обязаны, выбрасывать это исключение, если fromKey нельзя сравнить с ключами, которые в настоящее время находятся в карте.

NullPointerException - если fromKey равно null и эта карта использует естественный порядок сортировки, или её компаратор не допускает null-ключей

IllegalArgumentException - если у этой карты есть ограниченный диапазон, и fromKey выходит за пределы границ диапазона

replace

public boolean replace(K key,
                       V oldValue,
                       V newValue)

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

Заменяет запись для указанного ключа только в том случае, если она в настоящее время сопоставлена с указанным значением.

Указано в:

replace в интерфейсе Map<K,V>

Параметры:

key - ключ, с которым связано указанное значение

oldValue - ожидаемое значение, связанное с указанным ключом

newValue - значение, которое должно быть связано с указанным ключом

Возвращает:

true если значение было заменено

replace

public V replace(K key,
                 V value)

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

Заменяет запись для указанного ключа только в том случае, если она в настоящее время сопоставлена с каким-либо значением.

Указано в:

replace в интерфейсе Map<K,V>

Параметры:

key - ключ, с которым связано указанное значение

value - значение, которое должно быть связано с указанным ключом

Возвращает:

предыдущее значение, связанное с указанным ключом, или null , если для ключа не было сопоставления. (Возврат null также может указывать, что карта ранее сопоставила null с ключом, если реализация поддерживает null-значения.)

forEach

public void forEach(BiConsumer<? super K,? super V> action)

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

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

Указано в:

forEach в интерфейсе Map<K,V>

Параметры:

action - действие, которое должно быть выполнено для каждой записи

replaceAll

public void replaceAll(BiFunction<? super K,? super V,? extends V> function)

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

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

Указано в:

replaceAll в интерфейсе Map<K,V>

Параметры:

function - функция, которая должна быть применена к каждой записи