Класс TreeMap<K,V>

public TreeMap()

public TreeMap(Comparator<? super K> comparator)

Параметры:

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

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

Параметры:

m — карта, соответствия из которой следует поместить в эту карту

Исключения:

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

NullPointerException — если заданная карта равна null

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

Параметры:

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

Исключения:

NullPointerException — если заданная карта равна null

public int size()

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

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

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

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

Возвращает:

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

public boolean containsKey(Object key)

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

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

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

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

Параметры:

key — ключ, наличие которого в этой карте проверяется

Возвращает:

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

Исключения:

ClassCastException — если заданный ключ нельзя сравнить с ключами, находящимися в карте

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

public boolean containsValue(Object value)

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

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

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

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

Параметры:

value — значение, наличие которого в этой карте проверяется

Возвращает:

true, если существует соответствие значению value; иначе false

С версии:

1.2

public V get(Object key)

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

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

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

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

Параметры:

key — ключ, связанное значение которого следует вернуть

Возвращает:

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

Исключения:

ClassCastException — если заданный ключ нельзя сравнить с ключами, находящимися в карте

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

public Comparator<? super K> comparator()

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

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

Возвращает:

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

public K firstKey()

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

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

Возвращает:

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

Исключения:

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

public K lastKey()

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

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

Возвращает:

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

Исключения:

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

public V putFirst(K k, V v)

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

putFirst в интерфейсе SequencedMap<K,V>

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

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

Параметры:

k — ключ

v — значение

Возвращает:

значение, ранее связанное с k, или null, если такого значения не было

Исключения:

UnsupportedOperationException — всегда

С версии:

21

public V putLast(K k, V v)

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

putLast в интерфейсе SequencedMap<K,V>

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

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

Параметры:

k — ключ

v — значение

Возвращает:

значение, ранее связанное с k, или null, если такого значения не было

Исключения:

UnsupportedOperationException — всегда

С версии:

21

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

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

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

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

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

Параметры:

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

Исключения:

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

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

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

public V computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction)

map.computeIfAbsent(key, k -> new Value(f(k)));

map.computeIfAbsent(key, k -> new HashSet<V>()).add(v);

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

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

Параметры:

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

mappingFunction — функция отображения для вычисления значения

Возвращает:

текущее (существующее или вычисленное) значение, связанное с заданным ключом, или null, если вычисленное значение равно null

Исключения:

ConcurrentModificationException — если обнаружено, что функция отображения изменила эту карту

public V computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)

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

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

Параметры:

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

remappingFunction — функция пересопоставления для вычисления значения

Возвращает:

новое значение, связанное с заданным ключом, или null, если такого значения нет

Исключения:

ConcurrentModificationException — если обнаружено, что функция пересопоставления изменила эту карту

public V compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)

map.compute(key, (k, v) -> (v == null) ? msg : v.concat(msg))

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

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

Параметры:

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

remappingFunction — функция пересопоставления для вычисления значения

Возвращает:

новое значение, связанное с заданным ключом, или null, если такого значения нет

Исключения:

ConcurrentModificationException — если обнаружено, что функция пересопоставления изменила эту карту

public V merge(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction)

map.merge(key, msg, String::concat)

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

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

Параметры:

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

value — ненулевое значение, которое следует объединить с существующим значением, связанным с ключом, или связать с ключом, если существующего значения нет либо ему соответствует null

remappingFunction — функция пересопоставления для повторного вычисления имеющегося значения

Возвращает:

новое значение, связанное с заданным ключом, или null, если с ключом не связано никакое значение

Исключения:

ConcurrentModificationException — если обнаружено, что функция пересопоставления изменила эту карту

public V remove(Object key)

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

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

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

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

Параметры:

key — ключ, соответствие для которого следует удалить

Возвращает:

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

Исключения:

ClassCastException — если заданный ключ нельзя сравнить с ключами, находящимися в карте

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

public void clear()

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

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

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

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

public Object clone()

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

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

Возвращает:

поверхностную копию этой карты

См. также:

• Cloneable

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

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

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

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

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

Возвращает:

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

С версии:

1.6

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

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

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

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

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

Возвращает:

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

С версии:

1.6

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

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

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

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

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

Возвращает:

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

С версии:

1.6

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

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

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

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

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

Возвращает:

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

С версии:

1.6

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

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

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

Параметры:

key — ключ

Возвращает:

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

Исключения:

ClassCastException — если заданный ключ нельзя сравнить с ключами, находящимися в карте

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

С версии:

1.6

public K lowerKey(K key)

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

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

Параметры:

key — ключ

Возвращает:

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

Исключения:

ClassCastException — если заданный ключ нельзя сравнить с ключами, находящимися в карте

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

С версии:

1.6

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

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

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

Параметры:

key — ключ

Возвращает:

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

Исключения:

ClassCastException — если заданный ключ нельзя сравнить с ключами, находящимися в карте

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

С версии:

1.6

public K floorKey(K key)

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

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

Параметры:

key — ключ

Возвращает:

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

Исключения:

ClassCastException — если заданный ключ нельзя сравнить с ключами, находящимися в карте

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

С версии:

1.6

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

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

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

Параметры:

key — ключ

Возвращает:

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

Вызывает исключение:

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

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

Начиная с версии:

1.6

public K ceilingKey(K key)

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

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

Параметры:

key — ключ

Возвращает:

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

Вызывает исключение:

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

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

Начиная с версии:

1.6

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

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

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

Параметры:

key — ключ

Возвращает:

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

Вызывает исключение:

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

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

Начиная с версии:

1.6

public K higherKey(K key)

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

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

Параметры:

key — ключ

Возвращает:

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

Вызывает исключение:

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

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

Начиная с версии:

1.6

public Set<K> keySet()

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

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

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

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

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

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

Возвращает:

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

public NavigableSet<K> navigableKeySet()

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

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

Возвращает:

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

Начиная с версии:

1.6

public NavigableSet<K> descendingKeySet()

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

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

Возвращает:

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

Начиная с версии:

1.6

public Collection<V> values()

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

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

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

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

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

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

Возвращает:

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

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

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

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

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

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

Возвращает:

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

public NavigableMap<K,V> descendingMap()

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

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

Возвращает:

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

Начиная с версии:

1.6

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

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

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

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

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

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

Параметры:

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

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

Возвращает:

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

Вызывает исключение:

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

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

IllegalArgumentException — если сама карта имеет ограниченный диапазон и toKey находится за его пределами

Начиная с версии:

1.6

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

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

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

Параметры:

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

inclusive — true, если нижнюю границу нужно включить в возвращённое представление

Возвращает:

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

Вызывает исключение:

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

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

IllegalArgumentException — если сама карта имеет ограниченный диапазон и fromKey находится за его пределами

Начиная с версии:

1.6

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

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

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

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

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

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

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

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

Параметры:

toKey — верхняя граница (исключительно) ключей возвращённой карты

Возвращает:

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

Вызывает исключение:

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

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

IllegalArgumentException — если сама карта имеет ограниченный диапазон и toKey находится за его пределами

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

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

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

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

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

Параметры:

fromKey — нижняя граница (включительно) ключей возвращённой карты

Возвращает:

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

Вызывает исключение:

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

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

IllegalArgumentException — если сама карта имеет ограниченный диапазон и fromKey находится за его пределами