Интерфейс SortedSet<E>

Comparator<? super E> comparator()

Возвращает:

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

SortedSet<E> subSet(E fromElement, E toElement)

Параметры:

fromElement — нижняя граница (включительно) возвращаемого множества

toElement — верхняя граница (исключительно) возвращаемого множества

Возвращает:

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

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

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

NullPointerException — если fromElement или toElement имеет значение null, а это множество не допускает элементы null

IllegalArgumentException — если fromElement больше toElement; либо если само это множество имеет ограниченный диапазон, а fromElement или toElement находится за его пределами

SortedSet<E> headSet(E toElement)

Параметры:

toElement — верхняя граница (исключительно) возвращаемого множества

Возвращает:

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

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

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

NullPointerException — если toElement имеет значение null, а это множество не допускает элементы null

IllegalArgumentException — если само это множество имеет ограниченный диапазон, а toElement находится за его пределами

SortedSet<E> tailSet(E fromElement)

Параметры:

fromElement — нижняя граница (включительно) возвращаемого множества

Возвращает:

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

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

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

NullPointerException — если fromElement имеет значение null, а это множество не допускает элементы null

IllegalArgumentException — если само это множество имеет ограниченный диапазон, а fromElement находится за его пределами

E first()

Возвращает:

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

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

NoSuchElementException — если это множество пусто

E last()

Возвращает:

последний (наибольший) элемент, содержащийся в этом множестве в данный момент

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

NoSuchElementException — если это множество пусто

default Spliterator<E> spliterator()

Определён в:

spliterator в интерфейсе Collection<E>

Определён в:

spliterator в интерфейсе Iterable<E>

Определён в:

spliterator в интерфейсе Set<E>

Требования к реализации:

Реализация по умолчанию создаёт сплитератор с отложенной привязкой на основе Iterator отсортированного множества. Сплитератор наследует свойства fail-fast итератора множества. Компаратор сплитератора совпадает с компаратором отсортированного множества.

Созданный Spliterator дополнительно сообщает о характеристике Spliterator.SIZED.

Примечание по реализации:

Созданный Spliterator дополнительно сообщает о характеристике Spliterator.SUBSIZED.

Возвращает:

Spliterator для элементов этого отсортированного множества

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

1.8

default void addFirst(E e)

Определён в:

addFirst в интерфейсе SequencedCollection<E>

Требования к реализации:

Реализация в этом интерфейсе всегда выбрасывает UnsupportedOperationException.

Параметры:

e — добавляемый элемент

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

UnsupportedOperationException — всегда

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

21

default void addLast(E e)

Определён в:

addLast в интерфейсе SequencedCollection<E>

Требования к реализации:

Реализация в этом интерфейсе всегда выбрасывает UnsupportedOperationException.

Параметры:

e — добавляемый элемент.

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

UnsupportedOperationException — всегда

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

21

default E getFirst()

Определён в:

getFirst в интерфейсе SequencedCollection<E>

Требования к реализации:

Реализация в этом интерфейсе возвращает результат вызова метода first.

Возвращает:

полученный элемент

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

NoSuchElementException — если эта коллекция пуста

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

21

default E getLast()

Определён в:

getLast в интерфейсе SequencedCollection<E>

Требования к реализации:

Реализация в этом интерфейсе возвращает результат вызова метода last.

Возвращает:

полученный элемент

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

NoSuchElementException — если эта коллекция пуста

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

21

default E removeFirst()

Определён в:

removeFirst в интерфейсе SequencedCollection<E>

Требования к реализации:

Реализация в этом интерфейсе вызывает метод first для получения первого элемента, затем вызывает remove(element) для удаления элемента и возвращает этот элемент.

Возвращает:

удалённый элемент

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

NoSuchElementException — если эта коллекция пуста

UnsupportedOperationException — если реализация этой коллекции не поддерживает эту операцию

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

21

default E removeLast()

Определён в:

removeLast в интерфейсе SequencedCollection<E>

Требования к реализации:

Реализация в этом интерфейсе вызывает метод last для получения последнего элемента, затем вызывает remove(element) для удаления элемента и возвращает этот элемент.

Возвращает:

удалённый элемент

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

NoSuchElementException — если эта коллекция пуста

UnsupportedOperationException — если реализация этой коллекции не поддерживает эту операцию

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

21

default SortedSet<E> reversed()

Определён в:

reversed в интерфейсе SequencedCollection<E>

Определён в:

reversed в интерфейсе SequencedSet<E>

Требования к реализации:

Реализация в этом интерфейсе возвращает представление SortedSet в обратном порядке. Метод reversed() этого представления возвращает ссылку на этот SortedSet. Другие операции с представлением реализуются посредством вызовов открытых методов этого SortedSet. Точная взаимосвязь между вызовами для представления и вызовами для этого SortedSet не определена. Однако операции, зависящие от порядка, обычно ведут себя так, как если бы они делегировали вызов соответствующему методу с противоположной ориентацией. Например, вызов getFirst для представления может привести к вызову getLast для этого SortedSet.

Возвращает:

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

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

21