Класс ConcurrentSkipListSet<E>

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

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

Эта реализация обеспечивает ожидаемую среднюю временную сложность log(n) для операций contains, add и remove и их вариантов. Вставки, удаления и операции доступа безопасно выполняются одновременно несколькими потоками.

Итераторы и разделители являются слабо согласованными.

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

Обратите внимание, что, в отличие от большинства коллекций, метод size не является операцией с постоянным временем. Из-за асинхронной природы этих множеств определение текущего количества элементов требует обхода элементов, поэтому может сообщать неточные результаты, если эта коллекция изменяется во время обхода. Кроме того, массовые операции addAll, removeAll, retainAll, containsAll, equals и toArray не гарантируются как выполняемые атомарно. Например, итератор, работающий одновременно с операцией addAll, может видеть только некоторые добавленные элементы.

Этот класс и его итераторы реализуют все необязательные методы интерфейсов Set и Iterator. Как и большинство других реализаций конкурентных коллекций, этот класс не допускает использование null элементов, так как null аргументы и возвращаемые значения не могут быть надежно отличимы от отсутствия элементов.

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

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

ConcurrentSkipListSet

public ConcurrentSkipListSet()

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

ConcurrentSkipListSet

public ConcurrentSkipListSet(Comparator<? super E> comparator)

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

Параметры:

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

ConcurrentSkipListSet

public ConcurrentSkipListSet(Collection<? extends E> c)

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

Параметры:

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

Исключения:

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

NullPointerException - если указанная коллекция или любой из ее элементов являются null

ConcurrentSkipListSet

public ConcurrentSkipListSet(SortedSet<E> s)

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

Параметры:

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

Исключения:

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

Методы

clone

public ConcurrentSkipListSet<E> clone()

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

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

clone в классе Object

Возвращает:

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

См. также:

Cloneable

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.equals(e).

Указано в:

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

Указано в:

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

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

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

Параметры:

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

Возвращает:

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

Исключения:

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

NullPointerException - если указанный элемент равен null

add

public boolean add(E e)

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

Указано в:

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

Указано в:

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

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

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

Параметры:

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

Возвращает:

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

Исключения:

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

NullPointerException - если указанный элемент равен null

remove

public boolean remove(Object o)

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

Указано в:

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

Указано в:

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

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

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

Параметры:

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

Возвращает:

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

Исключения:

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

NullPointerException - если указанный элемент равен null

clear

public void clear()

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

Указано в:

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

Указано в:

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

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

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

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>

Возвращает:

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

equals

public boolean equals(Object o)

Сравнивает указанный объект с этим набором на равенство. Возвращает true, если указанный объект также является набором, два набора имеют одинаковый размер, и каждый член указанного набора содержится в этом наборе (или эквивалентно, каждый член этого набора содержится в указанном наборе). Это определение гарантирует, что метод equals работает правильно для различных реализаций интерфейса набора.

Указано в:

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

Указано в:

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

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

equals в классе AbstractSet<E>

Параметры:

o - объект, который нужно сравнить на равенство с этим набором

Возвращает:

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

См. также:

Object.hashCode(), HashMap

removeAll

public boolean removeAll(Collection<?> c)

Удаляет из этого набора все его элементы, которые содержатся в указанной коллекции. Если указанная коллекция также является набором, эта операция эффективно изменяет этот набор таким образом, чтобы его значением была асимметричная разность множеств двух наборов.

Указано в:

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

Указано в:

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

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

removeAll в классе AbstractSet<E>

Параметры:

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

Возвращает:

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

Исключения:

ClassCastException - если типы одного или нескольких элементов в этом наборе несовместимы с указанной коллекцией

NullPointerException - если указанная коллекция или любой из ее элементов являются null

См. также:

AbstractCollection.remove(Object), AbstractCollection.contains(Object)

lower

public E lower(E e)

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

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

Указано в:

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

Параметры:

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

Возвращает:

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

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

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

NullPointerException - если указанный элемент имеет значение null

floor

public E floor(E e)

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

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

Указано в:

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

Параметры:

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

Возвращает:

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

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

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

NullPointerException - если указанный элемент имеет значение null

ceiling

public E ceiling(E e)

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

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

Указано в:

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

Параметры:

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

Возвращает:

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

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

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

NullPointerException - если указанный элемент имеет значение null

higher

public E higher(E e)

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

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

Указано в:

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

Параметры:

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

Возвращает:

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

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

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

NullPointerException - если указанный элемент имеет значение null

pollFirst

public E pollFirst()

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

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

Указано в:

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

Возвращает:

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

pollLast

public E pollLast()

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

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

Указано в:

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

Возвращает:

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

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 - если этот набор пуст

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

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

headSet

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

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

Указано в:

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

Параметры:

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

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

Возвращает:

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

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

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

NullPointerException - если toElement имеет значение null

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

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

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

subSet

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

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

Specified by:

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

Specified by:

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

Parameters:

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

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

Returns:

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

Throws:

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

NullPointerException - если fromElement или toElement равно null

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

headSet

public NavigableSet<E> headSet(E toElement)

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

Specified by:

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

Specified by:

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

Parameters:

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

Returns:

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

Throws:

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

NullPointerException - если toElement равно null

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

tailSet

public NavigableSet<E> tailSet(E fromElement)

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

Specified by:

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

Specified by:

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

Parameters:

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

Returns:

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

Throws:

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

NullPointerException - если fromElement равно null

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

descendingSet

public NavigableSet<E> descendingSet()

Specified by:

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

Returns:

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

spliterator

public Spliterator<E> spliterator()

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

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

Returns:

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

Since:

1.8