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

public interface SortedMap<K,V> extends Map<K,V>

A Map, который дополнительно предоставляет полный порядок на своих ключах. Карта упорядочена в соответствии с естественным порядком своих ключей или с помощью Comparator, обычно предоставляемого при создании отсортированной карты. Этот порядок отражается при итерации по коллекционным представлениям отсортированной карты (возвращаемым методами entrySet, keySet и values). Предоставляются несколько дополнительных операций для использования преимуществ упорядочивания. (Этот интерфейс является аналогом карты для SortedSet.)

Все ключи, вставленные в отсортированную карту, должны реализовывать интерфейс Comparable (или быть приняты указанным компаратором). Кроме того, все такие ключи должны быть взаимно сравнимыми: k1.compareTo(k2) (или comparator.compare(k1, k2)) не должны выбрасывать ClassCastException для любых ключей k1 и k2 в отсортированной карте. Попытки нарушения этого ограничения приведут к тому, что вызов метода или конструктора, нарушающего условие, сгенерирует исключение ClassCastException.

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

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

1. Конструктор без аргументов, создающий пустую отсортированную карту, отсортированную в соответствии с естественным порядком ключей.
2. Конструктор с одним аргументом типа Comparator, который создаёт пустую отсортированную карту, отсортированную в соответствии с заданным компаратором.
3. Конструктор с одним аргументом типа Map, который создает новую карту с теми же сопоставлениями ключ-значение, что и аргумент, отсортированную в соответствии с естественным порядком ключей.
4. Конструктор с одним аргументом типа SortedMap, который создаёт новую отсортированную карту с теми же сопоставлениями ключ-значение и тем же порядком, что и входная отсортированная карта.

Примечание: несколько методов возвращают подкарты с ограниченными диапазонами ключей. Такие диапазоны полуоткрытые, то есть они включают свою нижнюю границу, но не верхнюю (если применимо). Если вам нужен замкнутый диапазон (который включает обе границы), и тип ключа допускает вычисление преемника заданного ключа, просто запросите поддиапазон от lowEndpoint до successor(highEndpoint). Например, предположим, что m — это карта, ключи которой являются строками. Следующий фрагмент кода получает представление, содержащее все сопоставления ключ-значение в m, ключи которых находятся между low и high, включительно:

   SortedMap<String, V> sub = m.subMap(low, high+"\0");

Аналогичный подход можно использовать для генерации открытого диапазона (который не содержит ни одной из границ). Следующий фрагмент кода получает представление, содержащее все сопоставления ключ-значение в m, ключи которых находятся между low и high, исключая границы:

   SortedMap<String, V> sub = m.subMap(low+"\0", high);

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