Класс TreeSet<E>

public class TreeSet<E>
extends AbstractSet<E>
implements NavigableSet<E>, Cloneable, Serializable

Реализация NavigableSet, основанная на TreeMap. Элементы упорядочиваются с использованием их естественного порядка или с помощью Comparator, предоставленного во время создания множества, в зависимости от используемого конструктора.

Эта реализация гарантирует затраты времени log(n) для основных операций (add, remove и contains).

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

Обратите внимание, что данная реализация не синхронизирована. Если несколько потоков одновременно обращаются к дереву множеств, и хотя бы один из потоков изменяет множество, оно должно быть синхронизировано внешним образом. Это обычно достигается путём синхронизации на некотором объекте, естественным образом инкапсулирующем множество. Если такой объект не существует, множество следует «упаковать» с помощью метода Collections.synchronizedSortedSet. Лучше всего это сделать во время создания, чтобы предотвратить случайный несинхронизированный доступ к множеству:

SortedSet s = Collections.synchronizedSortedSet(new TreeSet(...));

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

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

Этот класс является членом Java Collections Framework.

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

TreeSet

public TreeSet()

Создаёт новый пустой набор TreeSet, отсортированный в соответствии с естественным порядком элементов. Все элементы, вставленные в набор, должны реализовывать интерфейс Comparable. Кроме того, все такие элементы должны быть взаимосравнимыми: e1.compareTo(e2) не должен выбрасывать ClassCastException для любых элементов e1 и e2 в наборе. Если пользователь пытается добавить элемент в набор, который нарушает это ограничение (например, пользователь пытается добавить строковый элемент в набор, элементы которого являются целыми числами), вызов add сгенерирует исключение ClassCastException.

TreeSet

public TreeSet(Comparator<? super E> comparator)

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

Параметры:

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

TreeSet

public TreeSet(Collection<? extends E> c)

Создаёт новый набор TreeSet, содержащий элементы в указанной коллекции, отсортированные в соответствии с естественным порядком элементов. Все элементы, вставленные в набор, должны реализовывать интерфейс Comparable. Кроме того, все такие элементы должны быть взаимосравнимыми: e1.compareTo(e2) не должен выбрасывать ClassCastException для любых элементов e1 и e2 в наборе.

Параметры:

c - коллекция, элементы которой составят новый набор

Исключения:

ClassCastException - если элементы в c не являются Comparable или не являются взаимно сравнимыми

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

TreeSet

public TreeSet(SortedSet<E> s)

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

Параметры:

s - упорядоченный набор, элементы которого составят новый набор

Исключения:

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

Методы

iterator

public Iterator<E> iterator()

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

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

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

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

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

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

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

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

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

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

iterator в классе AbstractCollection<E>

Возвращает:

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

descendingIterator

public Iterator<E> descendingIterator()

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

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

descendingIterator в интерфейсе NavigableSet<E>

Возвращает:

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

С тех пор, как:

1.6

descendingSet

public NavigableSet<E> descendingSet()

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

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

descendingSet в интерфейсе NavigableSet<E>

Возвращает:

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

С тех пор, как:

1.6

size

public int size()

Возвращает количество элементов в этом наборе (его мощность).

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

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

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

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

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

size в классе AbstractCollection<E>

Возвращает:

количество элементов в этом наборе (его мощность)

isEmpty

public boolean isEmpty()

Возвращает true , если этот набор не содержит элементов.

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

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

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

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

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

isEmpty в классе AbstractCollection<E>

Возвращает:

true , если этот набор не содержит элементов

contains

public boolean contains(Object o)

Возвращает true , если этот набор содержит указанный элемент. Более формально, возвращает true тогда и только тогда, когда этот набор содержит элемент e такой, что (o==null ? e==null : o.equals(e)).

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

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

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

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

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

contains в классе AbstractCollection<E>

Параметры:

o - объект, проверяемый на наличие в этом наборе

Возвращает:

true , если этот набор содержит указанный элемент

Исключения:

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

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

add

public boolean add(E e)

Добавляет указанный элемент в этот набор, если он ещё не присутствует. Более формально, добавляет указанный элемент e в этот набор, если набор не содержит элемент e2 такой, что (e==null ? e2==null : e.equals(e2)). Если этот набор уже содержит элемент, вызов оставляет набор без изменений и возвращает false.

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

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

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

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

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

add в классе AbstractCollection<E>

Параметры:

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

Возвращает:

true , если этот набор ещё не содержал указанного элемента

Исключения:

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

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

remove

public boolean remove(Object o)

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

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

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

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

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

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

remove в классе AbstractCollection<E>

Параметры:

o - объект, который нужно удалить из этого набора, если он присутствует

Возвращает:

true , если этот набор содержал указанный элемент

Исключения:

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

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

clear

public void clear()

Удаляет все элементы из этого набора. Набор будет пустым после возвращения этого вызова.

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

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

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

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

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

clear в классе AbstractCollection<E>

addAll

public boolean addAll(Collection<? extends E> c)

Добавляет все элементы из указанной коллекции в этот набор.

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

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

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

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

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

addAll в классе AbstractCollection<E>

Параметры:

c - коллекция, содержащая элементы, которые нужно добавить в этот набор

Возвращает:

true , если этот набор изменился в результате вызова

Исключения:

ClassCastException - если предоставленные элементы не могут быть сравнены с элементами, которые в настоящее время находятся в наборе

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

См. также:

AbstractCollection.add(Object)

subSet

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

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

Указано в:

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

Параметры:

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

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

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

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

Возвращает:

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

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

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

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

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

С:

1.6

headSet

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

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

Указано в:

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

Параметры:

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

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

Возвращает:

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

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

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

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

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

С:

1.6

tailSet

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

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

Указано в:

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

Параметры:

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

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

Возвращает:

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

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

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

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

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

С:

1.6

subSet

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

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

Указано в:

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

Указано в:

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

Параметры:

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

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

Возвращает:

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

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

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

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

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

headSet

public SortedSet<E> headSet(E toElement)

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

Указано в:

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

Указано в:

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

Параметры:

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

Возвращает:

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

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

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

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

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

tailSet

public SortedSet<E> tailSet(E fromElement)

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

Указано в:

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

Указано в:

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

Параметры:

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

Возвращает:

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

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

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

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

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

comparator

public Comparator<? super E> comparator()

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

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

Указано в:

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

Возвращает:

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

first

public E first()

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

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

Указано в:

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

Возвращает:

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

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

NoSuchElementException - если этот набор пуст

last

public E last()

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

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

Указано в:

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

Возвращает:

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

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

NoSuchElementException - если этот набор пуст

lower

public E lower(E e)

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

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

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

lower в интерфейсе NavigableSet<E>

Параметры:

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

Возвращает:

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

Исключения:

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

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

С:

1.6

floor

public E floor(E e)

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

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

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

floor в интерфейсе NavigableSet<E>

Параметры:

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

Возвращает:

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

Исключения:

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

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

С:

1.6

ceiling

public E ceiling(E e)

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

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

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

ceiling в интерфейсе NavigableSet<E>

Параметры:

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

Возвращает:

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

Исключения:

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

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

С:

1.6

higher

public E higher(E e)

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

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

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

higher в интерфейсе NavigableSet<E>

Параметры:

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

Возвращает:

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

Исключения:

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

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

С:

1.6

pollFirst

public E pollFirst()

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

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

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

pollFirst в интерфейсе NavigableSet<E>

Возвращает:

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

С:

1.6

pollLast

public E pollLast()

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

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

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

pollLast в интерфейсе NavigableSet<E>

Возвращает:

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

С:

1.6

clone

public Object clone()

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

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

clone в классе Object

Возвращает:

неглубокую копию этого набора

См. также:

Cloneable

spliterator

public Spliterator<E> spliterator()

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

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

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

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

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

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

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

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

Возвращает:

Spliterator по элементам в этом наборе

С:

1.8