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

public interface NavigableSet<E>
extends SortedSet<E>

A SortedSet расширенный методами навигации, которые сообщают о ближайших соответствиях для заданных целей поиска. Методы lower, floor, ceiling, и higher возвращают элементы, соответственно, меньше, меньше или равно, больше или равно и больше заданного элемента, возвращая null если такого элемента нет. К NavigableSet можно получить доступ и перебрать его в порядке возрастания или убывания. Метод descendingSet возвращает представление множества с инвертированными значениями всех реляционных и направленных методов. Производительность восходящих операций и представлений, вероятно, будет выше, чем у нисходящих. Этот интерфейс дополнительно определяет методы pollFirst и pollLast, которые возвращают и удаляют наименьший и наибольший элемент, если они существуют, иначе возвращают null. Методы subSet, headSet, и tailSet отличаются от одноимённых методов SortedSet тем, что принимают дополнительные аргументы, описывающие, являются ли нижние и верхние границы включительными или исключительными. Подмножества любого NavigableSet должны реализовывать интерфейс NavigableSet.

Значения, возвращаемые методами навигации, могут быть неоднозначными в реализациях, которые допускают null элементы. Однако даже в этом случае результат можно уточнить, проверив contains(null). Чтобы избежать таких проблем, реализациям этого интерфейса рекомендуется *не* допускать вставки null элементов. (Обратите внимание, что упорядоченные множества элементов Comparable по своей природе не допускают null.)

Методы subSet(E, E), headSet(E), и tailSet(E) указаны для возврата SortedSet для совместимой модернизации существующих реализаций SortedSet для реализации NavigableSet, но расширениям и реализациям этого интерфейса рекомендуется переопределять эти методы для возврата NavigableSet.

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

Методы

lower

E lower(E e)

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

Параметры:

e - значение для сопоставления

Возвращает:

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

Исключения:

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

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

floor

E floor(E e)

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

Параметры:

e - значение для сопоставления

Возвращает:

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

Исключения:

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

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

ceiling

E ceiling(E e)

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

Параметры:

e - значение для сопоставления

Возвращает:

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

Исключения:

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

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

higher

E higher(E e)

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

Параметры:

e - значение для сопоставления

Возвращает:

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

Исключения:

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

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

pollFirst

E pollFirst()

Извлекает и удаляет первый (наименьший) элемент или возвращает null , если этот набор пуст.

Возвращает:

первый элемент или null , если этот набор пуст

pollLast

E pollLast()

Извлекает и удаляет последний (наибольший) элемент или возвращает null , если этот набор пуст.

Возвращает:

последний элемент или null , если этот набор пуст

iterator

Iterator<E> iterator()

Возвращает итератор по элементам этого набора в порядке возрастания.

Задано в:

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

Задано в:

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

Задано в:

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

Возвращает:

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

descendingSet

NavigableSet<E> descendingSet()

Возвращает:

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

descendingIterator

Iterator<E> descendingIterator()

Возвращает итератор по элементам этого набора в порядке убывания. Эквивалентно descendingSet().iterator().

Возвращает:

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

subSet

NavigableSet<E> subSet(E fromElement,
                       boolean fromInclusive,
                       E toElement,
                       boolean toInclusive)

Параметры:

fromElement - нижняя граница возвращаемого набора

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

toElement - верхняя граница возвращаемого набора

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

Возвращает:

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

Исключения:

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

NullPointerException - если fromElement или toElement имеют значение null, и этот набор не допускает элементов null

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

headSet

NavigableSet<E> headSet(E toElement,
                        boolean inclusive)

Параметры:

toElement - верхняя граница возвращаемого набора

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

Возвращает:

представление части этого набора, элементы которого меньше (или меньше или равны, если inclusive истинно) toElement

Исключения:

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

NullPointerException - если toElement имеет значение null, и этот набор не допускает элементов null

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

tailSet

NavigableSet<E> tailSet(E fromElement,
                        boolean inclusive)

Параметры:

fromElement - нижняя граница возвращаемого набора

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

Возвращает:

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

Исключения:

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

NullPointerException - если fromElement имеет значение null, и этот набор не допускает элементов null

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

subSet

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

Указано в:

subSet в интерфейсе SortedSet<E>

Параметры:

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

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

Возвращает:

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

Бросает:

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

NullPointerException - если fromElement или toElement равно null, и этот набор не допускает null-элементов

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

headSet

SortedSet<E> headSet(E toElement)

Указано в:

headSet в интерфейсе SortedSet<E>

Параметры:

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

Возвращает:

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

Бросает:

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

NullPointerException - если toElement равно null, и этот набор не допускает null-элементов

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

tailSet

SortedSet<E> tailSet(E fromElement)

Указано в:

tailSet в интерфейсе SortedSet<E>

Параметры:

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

Возвращает:

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

Бросает:

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

NullPointerException - если fromElement равно null, и этот набор не допускает null-элементов

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