OpenJDK 1.22 · java.util.concurrent.ConcurrentSkipListSet

Modifier and Type	Field and Description
private final ConcurrentNavigableMap<E, Object>	m The underlying map.
private static final long	serialVersionUID

Access	Constructor and Description
public	ConcurrentSkipListSet() Constructs a new, empty set that orders its elements according to their natural ordering.
public	ConcurrentSkipListSet(Comparator<? super E> the comparator that will be used to order this set. If `null`, the natural ordering of the elements will be used. comparator) Constructs a new, empty set that orders its elements according to the specified comparator.
public	ConcurrentSkipListSet(Collection<? extends E> The elements that will comprise the new set c) Constructs a new set containing the elements in the specified collection, that orders its elements according to their natural ordering.
public	ConcurrentSkipListSet(SortedSet<E> sorted set whose elements will comprise the new set s) Constructs a new set containing the same elements and using the same ordering as the specified sorted set.
pack-priv	ConcurrentSkipListSet(ConcurrentNavigableMap<E, Object> m) For use by submaps

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if this set did not already contain the specified element add(E element to be added to this set e) Overrides java.util.AbstractCollection.add. Implements java.util.Set.add, java.util.Collection.add. Adds the specified element to this set if it is not already present.
public void	addFirst(E the element to be added e) Overrides default java.util.SortedSet.addFirst. Throws `UnsupportedOperationException`.
public void	addLast(E the element to be added. e) Overrides default java.util.SortedSet.addLast. Throws `UnsupportedOperationException`.
public E	ceiling(E the value to match e) Implements java.util.NavigableSet.ceiling. Returns the least element in this set greater than or equal to the given element, or `null` if there is no such element.
public void	clear() Overrides java.util.AbstractCollection.clear. Implements java.util.Set.clear, java.util.Collection.clear. Removes all of the elements from this set.
public ConcurrentSkipListSet<E>	Returns: a shallow copy of this set clone() Overrides java.lang.Object.clone. Returns a shallow copy of this `ConcurrentSkipListSet` instance.
public Comparator<? super E>	comparator() Implements java.util.SortedSet.comparator. Returns the comparator used to order the elements in this set, or `null` if this set uses the natural ordering of its elements.
public boolean	Returns: `true` if this set contains the specified element contains(Object object to be checked for containment in this set o) Overrides java.util.AbstractCollection.contains. Implements java.util.Set.contains, java.util.Collection.contains. Returns `true` if this set contains the specified element.
public Iterator<E>	Returns: an iterator over the elements in this set in descending order descendingIterator() Implements java.util.NavigableSet.descendingIterator. Returns an iterator over the elements in this set in descending order.
public NavigableSet<E>	Returns: a reverse order view of this set descendingSet() Implements java.util.NavigableSet.descendingSet. Returns a reverse order view of the elements contained in this set.
public boolean	Returns: `true` if the specified object is equal to this set equals(Object the object to be compared for equality with this set o) Overrides java.util.AbstractSet.equals. Implements java.util.Set.equals, java.util.Collection.equals. Compares the specified object with this set for equality.
public E	first() Implements java.util.SortedSet.first. Returns the first (lowest) element currently in this set.
public E	floor(E the value to match e) Implements java.util.NavigableSet.floor. Returns the greatest element in this set less than or equal to the given element, or `null` if there is no such element.
public NavigableSet<E>	headSet(E high endpoint of the returned set toElement, boolean `true` if the high endpoint is to be included in the returned view inclusive) Implements java.util.NavigableSet.headSet. Returns a view of the portion of this set whose elements are less than (or equal to, if `inclusive` is true) `toElement`.
public NavigableSet<E>	headSet(E high endpoint (exclusive) of the returned set toElement) Implements java.util.NavigableSet.headSet. Returns a view of the portion of this set whose elements are strictly less than `toElement`.
public E	higher(E the value to match e) Implements java.util.NavigableSet.higher. Returns the least element in this set strictly greater than the given element, or `null` if there is no such element.
public boolean	Returns: `true` if this set contains no elements isEmpty() Overrides java.util.AbstractCollection.isEmpty. Implements java.util.Set.isEmpty, java.util.Collection.isEmpty. Returns `true` if this set contains no elements.
public Iterator<E>	Returns: an iterator over the elements in this set in ascending order iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.NavigableSet.iterator, java.util.Set.iterator, java.util.Collection.iterator. Returns an iterator over the elements in this set in ascending order.
public E	last() Implements java.util.SortedSet.last. Returns the last (highest) element currently in this set.
public E	lower(E the value to match e) Implements java.util.NavigableSet.lower. Returns the greatest element in this set strictly less than the given element, or `null` if there is no such element.
public E	pollFirst() Implements java.util.NavigableSet.pollFirst. Retrieves and removes the first (lowest) element, or returns `null` if this set is empty (optional operation).
public E	pollLast() Implements java.util.NavigableSet.pollLast. Retrieves and removes the last (highest) element, or returns `null` if this set is empty (optional operation).
public boolean	Returns: `true` if this set contained the specified element remove(Object object to be removed from this set, if present o) Overrides java.util.AbstractCollection.remove. Implements java.util.Set.remove, java.util.Collection.remove. Removes the specified element from this set if it is present.
public boolean	Returns: `true` if this set changed as a result of the call removeAll(Collection<?> collection containing elements to be removed from this set c) Overrides java.util.AbstractSet.removeAll. Implements java.util.Set.removeAll, java.util.Collection.removeAll. Removes from this set all of its elements that are contained in the specified collection.
private void	setMap(ConcurrentNavigableMap<E, Object> map) Initializes map field; for use in clone.
public int	Returns: the number of elements in this set size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Set.size, java.util.Collection.size. Returns the number of elements in this set.
public Spliterator<E>	Returns: a `Spliterator` over the elements in this set spliterator() Overrides default java.util.SortedSet.spliterator, java.util.Set.spliterator, java.util.Collection.spliterator. Returns a `Spliterator` over the elements in this set.
public NavigableSet<E>	subSet(E low endpoint of the returned set fromElement, boolean `true` if the low endpoint is to be included in the returned view fromInclusive, E high endpoint of the returned set toElement, boolean `true` if the high endpoint is to be included in the returned view toInclusive) Implements java.util.NavigableSet.subSet. Returns a view of the portion of this set whose elements range from `fromElement` to `toElement`.
public NavigableSet<E>	subSet(E low endpoint (inclusive) of the returned set fromElement, E high endpoint (exclusive) of the returned set toElement) Implements java.util.NavigableSet.subSet. Returns a view of the portion of this set whose elements range from `fromElement`, inclusive, to `toElement`, exclusive.
public NavigableSet<E>	tailSet(E low endpoint of the returned set fromElement, boolean `true` if the low endpoint is to be included in the returned view inclusive) Implements java.util.NavigableSet.tailSet. Returns a view of the portion of this set whose elements are greater than (or equal to, if `inclusive` is true) `fromElement`.
public NavigableSet<E>	tailSet(E low endpoint (inclusive) of the returned set fromElement) Implements java.util.NavigableSet.tailSet. Returns a view of the portion of this set whose elements are greater than or equal to `fromElement`.

Inherited from java.util.AbstractSet:: hashCode

m	back to summary
private final ConcurrentNavigableMap<E, Object> m The underlying map. Uses Boolean.TRUE as value for each element. This field is declared final for the sake of thread safety, which entails some ugliness in clone(). Annotations @SuppressWarnings:serial

serialVersionUID	back to summary
private static final long serialVersionUID

ConcurrentSkipListSet	back to summary
public ConcurrentSkipListSet() Constructs a new, empty set that orders its elements according to their natural ordering.

ConcurrentSkipListSet	back to summary
public ConcurrentSkipListSet(Comparator<? super E> comparator) Constructs a new, empty set that orders its elements according to the specified comparator. Parameters comparator:Comparator<? super E> the comparator that will be used to order this set. If `null`, the natural ordering of the elements will be used.

ConcurrentSkipListSet	back to summary
public ConcurrentSkipListSet(Collection<? extends E> c) Constructs a new set containing the elements in the specified collection, that orders its elements according to their natural ordering. Parameters c:Collection<? extends E> The elements that will comprise the new set Exceptions ClassCastException: if the elements in `c` are not `Comparable`, or are not mutually comparable NullPointerException: if the specified collection or any of its elements are null

ConcurrentSkipListSet	back to summary
public ConcurrentSkipListSet(SortedSet<E> s) Constructs a new set containing the same elements and using the same ordering as the specified sorted set. Parameters s:SortedSet<E> sorted set whose elements will comprise the new set Exceptions NullPointerException: if the specified sorted set or any of its elements are null

ConcurrentSkipListSet	back to summary
pack-priv ConcurrentSkipListSet(ConcurrentNavigableMap<E, Object> m) For use by submaps

Method Detail

add back to summary

add	back to summary
public boolean add(E e) Overrides java.util.AbstractCollection.add. Implements java.util.Set.add, java.util.Collection.add. Adds the specified element to this set if it is not already present. More formally, adds the specified element `e` to this set if the set contains no element `e2` such that `e.equals(e2)`. If this set already contains the element, the call leaves the set unchanged and returns `false`. Parameters e:E element to be added to this set Returns:boolean `true` if this set did not already contain the specified element Exceptions ClassCastException: if `e` cannot be compared with the elements currently in this set NullPointerException: if the specified element is null

public boolean add(E e)

Overrides java.util.AbstractCollection.add.

Implements java.util.Set.add, java.util.Collection.add.

Adds the specified element to this set if it is not already present. More formally, adds the specified element e to this set if the set contains no element e2 such that e.equals(e2). If this set already contains the element, the call leaves the set unchanged and returns false.

Parameters

e:E: element to be added to this set

Returns:boolean

true if this set did not already contain the specified element

Exceptions

ClassCastException:: if e cannot be compared with the elements currently in this set
NullPointerException:: if the specified element is null

addFirst back to summary

addFirst	back to summary
public void addFirst(E e) Overrides default java.util.SortedSet.addFirst. Throws `UnsupportedOperationException`. The encounter order induced by this set's comparison method determines the position of elements, so explicit positioning is not supported. Parameters e:E Doc from java.util.SequencedCollection.addFirst. the element to be added Exceptions UnsupportedOperationException: always Since 21

public void addFirst(E e)

Overrides default java.util.SortedSet.addFirst.

Throws UnsupportedOperationException. The encounter order induced by this set's comparison method determines the position of elements, so explicit positioning is not supported.

Parameters

e:E

Doc from java.util.SequencedCollection.addFirst.

the element to be added

Exceptions

UnsupportedOperationException:: always

Since

addLast back to summary

addLast	back to summary
public void addLast(E e) Overrides default java.util.SortedSet.addLast. Throws `UnsupportedOperationException`. The encounter order induced by this set's comparison method determines the position of elements, so explicit positioning is not supported. Parameters e:E Doc from java.util.SequencedCollection.addLast. the element to be added. Exceptions UnsupportedOperationException: always Since 21

public void addLast(E e)

Overrides default java.util.SortedSet.addLast.

Throws UnsupportedOperationException. The encounter order induced by this set's comparison method determines the position of elements, so explicit positioning is not supported.

Parameters

e:E

Doc from java.util.SequencedCollection.addLast.

the element to be added.

Exceptions

UnsupportedOperationException:: always

Since

ceiling back to summary

ceiling	back to summary
public E ceiling(E e) Implements java.util.NavigableSet.ceiling. Doc from java.util.NavigableSet.ceiling. Returns the least element in this set greater than or equal to the given element, or `null` if there is no such element. Parameters e:E the value to match Returns:E the least element greater than or equal to `e`, or `null` if there is no such element Exceptions ClassCastException: if the specified element cannot be compared with the elements currently in the set NullPointerException: if the specified element is null

public E ceiling(E e)

Implements java.util.NavigableSet.ceiling.

Doc from java.util.NavigableSet.ceiling.

Returns the least element in this set greater than or equal to the given element, or null if there is no such element.

Parameters

e:E: the value to match

Returns:E

the least element greater than or equal to e, or null if there is no such element

Exceptions

ClassCastException:: if the specified element cannot be compared with the elements currently in the set
NullPointerException:: if the specified element is null

clear	back to summary
public void clear() Overrides java.util.AbstractCollection.clear. Implements java.util.Set.clear, java.util.Collection.clear. Removes all of the elements from this set.

clear

back to summary

public void clear()

Overrides java.util.AbstractCollection.clear.

Implements java.util.Set.clear, java.util.Collection.clear.

Removes all of the elements from this set.

clone back to summary

clone	back to summary
public ConcurrentSkipListSet<E> clone() Overrides java.lang.Object.clone. Returns a shallow copy of this `ConcurrentSkipListSet` instance. (The elements themselves are not cloned.) Returns:ConcurrentSkipListSet<E> a shallow copy of this set

public ConcurrentSkipListSet<E> clone()

Overrides java.lang.Object.clone.

Returns a shallow copy of this ConcurrentSkipListSet instance. (The elements themselves are not cloned.)

Returns:ConcurrentSkipListSet<E>: a shallow copy of this set

comparator back to summary

comparator	back to summary
public Comparator<? super E> comparator() Implements java.util.SortedSet.comparator. Doc from java.util.SortedSet.comparator. Returns the comparator used to order the elements in this set, or `null` if this set uses the natural ordering of its elements. Returns:Comparator<? super E> the comparator used to order the elements in this set, or `null` if this set uses the natural ordering of its elements

public Comparator<? super E> comparator()

Implements java.util.SortedSet.comparator.

Doc from java.util.SortedSet.comparator.

Returns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.

Returns:Comparator<? super E>: the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements

contains back to summary

contains	back to summary
public boolean contains(Object o) Overrides java.util.AbstractCollection.contains. Implements java.util.Set.contains, java.util.Collection.contains. Returns `true` if this set contains the specified element. More formally, returns `true` if and only if this set contains an element `e` such that `o.equals(e)`. Parameters o:Object object to be checked for containment in this set Returns:boolean `true` if this set contains the specified element Exceptions ClassCastException: if the specified element cannot be compared with the elements currently in this set NullPointerException: if the specified element is null

public boolean contains(Object o)

Overrides java.util.AbstractCollection.contains.

Implements java.util.Set.contains, java.util.Collection.contains.

Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that o.equals(e).

Parameters

o:Object: object to be checked for containment in this set

Returns:boolean

true if this set contains the specified element

Exceptions

ClassCastException:: if the specified element cannot be compared with the elements currently in this set
NullPointerException:: if the specified element is null

descendingIterator	back to summary
public Iterator<E> descendingIterator() Implements java.util.NavigableSet.descendingIterator. Returns an iterator over the elements in this set in descending order. Returns:Iterator<E> an iterator over the elements in this set in descending order

descendingIterator

back to summary

public Iterator<E> descendingIterator()

Implements java.util.NavigableSet.descendingIterator.

Returns an iterator over the elements in this set in descending order.

Returns:Iterator<E>: an iterator over the elements in this set in descending order

descendingSet back to summary

descendingSet	back to summary
public NavigableSet<E> descendingSet() Implements java.util.NavigableSet.descendingSet. Returns a reverse order view of the elements contained in this set. The descending set is backed by this set, so changes to the set are reflected in the descending set, and vice-versa. The returned set has an ordering equivalent to `Collections.reverseOrder(comparator())`. The expression `s.descendingSet().descendingSet()` returns a view of `s` essentially equivalent to `s`. Returns:NavigableSet<E> a reverse order view of this set

public NavigableSet<E> descendingSet()

Implements java.util.NavigableSet.descendingSet.

Returns a reverse order view of the elements contained in this set. The descending set is backed by this set, so changes to the set are reflected in the descending set, and vice-versa.

The returned set has an ordering equivalent to Collections.reverseOrder(comparator()). The expression s.descendingSet().descendingSet() returns a view of s essentially equivalent to s.

Returns:NavigableSet<E>: a reverse order view of this set

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.util.AbstractSet.equals. Implements java.util.Set.equals, java.util.Collection.equals. Compares the specified object with this set for equality. Returns `true` if the specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the set interface. Parameters o:Object the object to be compared for equality with this set Returns:boolean `true` if the specified object is equal to this set

public boolean equals(Object o)

Overrides java.util.AbstractSet.equals.

Implements java.util.Set.equals, java.util.Collection.equals.

Compares the specified object with this set for equality. Returns true if the specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the set interface.

Parameters

o:Object: the object to be compared for equality with this set

Returns:boolean

true if the specified object is equal to this set

first	back to summary
public E first() Implements java.util.SortedSet.first. Doc from java.util.SortedSet.first. Returns the first (lowest) element currently in this set. Returns:E the first (lowest) element currently in this set Exceptions NoSuchElementException: if this set is empty

first

back to summary

public E first()

Implements java.util.SortedSet.first.

Doc from java.util.SortedSet.first.

Returns the first (lowest) element currently in this set.

Returns:E

the first (lowest) element currently in this set

Exceptions

NoSuchElementException:: if this set is empty

floor back to summary

floor	back to summary
public E floor(E e) Implements java.util.NavigableSet.floor. Doc from java.util.NavigableSet.floor. Returns the greatest element in this set less than or equal to the given element, or `null` if there is no such element. Parameters e:E the value to match Returns:E the greatest element less than or equal to `e`, or `null` if there is no such element Exceptions ClassCastException: if the specified element cannot be compared with the elements currently in the set NullPointerException: if the specified element is null

public E floor(E e)

Implements java.util.NavigableSet.floor.

Doc from java.util.NavigableSet.floor.

Returns the greatest element in this set less than or equal to the given element, or null if there is no such element.

Parameters

e:E: the value to match

Returns:E

the greatest element less than or equal to e, or null if there is no such element

Exceptions

ClassCastException:: if the specified element cannot be compared with the elements currently in the set
NullPointerException:: if the specified element is null

headSet back to summary

headSet	back to summary
public NavigableSet<E> headSet(E toElement, boolean inclusive) Implements java.util.NavigableSet.headSet. Doc from java.util.NavigableSet.headSet. Returns a view of the portion of this set whose elements are less than (or equal to, if `inclusive` is true) `toElement`. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports. The returned set will throw an `IllegalArgumentException` on an attempt to insert an element outside its range. Parameters toElement:E high endpoint of the returned set inclusive:boolean `true` if the high endpoint is to be included in the returned view Returns:NavigableSet<E> a view of the portion of this set whose elements are less than (or equal to, if `inclusive` is true) `toElement` Exceptions ClassCastException: if `toElement` is not compatible with this set's comparator (or, if the set has no comparator, if `toElement` does not implement `Comparable`). Implementations may, but are not required to, throw this exception if `toElement` cannot be compared to elements currently in the set. NullPointerException: if `toElement` is null IllegalArgumentException: if this set itself has a restricted range, and `toElement` lies outside the bounds of the range

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

Implements java.util.NavigableSet.headSet.

Doc from java.util.NavigableSet.headSet.

Returns a view of the portion of this set whose elements are less than (or equal to, if inclusive is true) toElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

Parameters

toElement:E: high endpoint of the returned set
inclusive:boolean: true if the high endpoint is to be included in the returned view

Returns:NavigableSet<E>

a view of the portion of this set whose elements are less than (or equal to, if inclusive is true) toElement

Exceptions

ClassCastException:: if toElement is not compatible with this set's comparator (or, if the set has no comparator, if toElement does not implement Comparable). Implementations may, but are not required to, throw this exception if toElement cannot be compared to elements currently in the set.
NullPointerException:: if toElement is null
IllegalArgumentException:: if this set itself has a restricted range, and toElement lies outside the bounds of the range

headSet back to summary

headSet	back to summary
public NavigableSet<E> headSet(E toElement) Implements java.util.NavigableSet.headSet. Doc from java.util.NavigableSet.headSet. Returns a view of the portion of this set whose elements are strictly less than `toElement`. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports. The returned set will throw an `IllegalArgumentException` on an attempt to insert an element outside its range. Equivalent to `headSet(toElement, false)`. Parameters toElement:E Doc from java.util.SortedSet.headSet. high endpoint (exclusive) of the returned set Returns:NavigableSet<E> Doc from java.util.SortedSet.headSet. a view of the portion of this set whose elements are strictly less than `toElement` Exceptions ClassCastException: if `toElement` is not compatible with this set's comparator (or, if the set has no comparator, if `toElement` does not implement `Comparable`). Implementations may, but are not required to, throw this exception if `toElement` cannot be compared to elements currently in the set. NullPointerException: if `toElement` is null IllegalArgumentException: if this set itself has a restricted range, and `toElement` lies outside the bounds of the range

public NavigableSet<E> headSet(E toElement)

Implements java.util.NavigableSet.headSet.

Doc from java.util.NavigableSet.headSet.

Returns a view of the portion of this set whose elements are strictly less than toElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

Equivalent to headSet(toElement, false).

Parameters

toElement:E

Doc from java.util.SortedSet.headSet.

high endpoint (exclusive) of the returned set

Returns:NavigableSet<E>

Doc from java.util.SortedSet.headSet.

a view of the portion of this set whose elements are strictly less than toElement

Exceptions

ClassCastException:: if toElement is not compatible with this set's comparator (or, if the set has no comparator, if toElement does not implement Comparable). Implementations may, but are not required to, throw this exception if toElement cannot be compared to elements currently in the set.
NullPointerException:: if toElement is null
IllegalArgumentException:: if this set itself has a restricted range, and toElement lies outside the bounds of the range

higher back to summary

higher	back to summary
public E higher(E e) Implements java.util.NavigableSet.higher. Doc from java.util.NavigableSet.higher. Returns the least element in this set strictly greater than the given element, or `null` if there is no such element. Parameters e:E the value to match Returns:E the least element greater than `e`, or `null` if there is no such element Exceptions ClassCastException: if the specified element cannot be compared with the elements currently in the set NullPointerException: if the specified element is null

public E higher(E e)

Implements java.util.NavigableSet.higher.

Doc from java.util.NavigableSet.higher.

Returns the least element in this set strictly greater than the given element, or null if there is no such element.

Parameters

e:E: the value to match

Returns:E

the least element greater than e, or null if there is no such element

Exceptions

ClassCastException:: if the specified element cannot be compared with the elements currently in the set
NullPointerException:: if the specified element is null

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Overrides java.util.AbstractCollection.isEmpty. Implements java.util.Set.isEmpty, java.util.Collection.isEmpty. Returns `true` if this set contains no elements. Returns:boolean `true` if this set contains no elements

public boolean isEmpty()

Overrides java.util.AbstractCollection.isEmpty.

Implements java.util.Set.isEmpty, java.util.Collection.isEmpty.

Returns true if this set contains no elements.

Returns:boolean: true if this set contains no elements

iterator	back to summary
public Iterator<E> iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.NavigableSet.iterator, java.util.Set.iterator, java.util.Collection.iterator. Returns an iterator over the elements in this set in ascending order. Returns:Iterator<E> an iterator over the elements in this set in ascending order

iterator

back to summary

public Iterator<E> iterator()

Implements abstract java.util.AbstractCollection.iterator.

Implements java.util.NavigableSet.iterator, java.util.Set.iterator, java.util.Collection.iterator.

Returns an iterator over the elements in this set in ascending order.

Returns:Iterator<E>: an iterator over the elements in this set in ascending order

last	back to summary
public E last() Implements java.util.SortedSet.last. Doc from java.util.SortedSet.last. Returns the last (highest) element currently in this set. Returns:E the last (highest) element currently in this set Exceptions NoSuchElementException: if this set is empty

last

back to summary

public E last()

Implements java.util.SortedSet.last.

Doc from java.util.SortedSet.last.

Returns the last (highest) element currently in this set.

Returns:E

the last (highest) element currently in this set

Exceptions

NoSuchElementException:: if this set is empty

lower back to summary

lower	back to summary
public E lower(E e) Implements java.util.NavigableSet.lower. Doc from java.util.NavigableSet.lower. Returns the greatest element in this set strictly less than the given element, or `null` if there is no such element. Parameters e:E the value to match Returns:E the greatest element less than `e`, or `null` if there is no such element Exceptions ClassCastException: if the specified element cannot be compared with the elements currently in the set NullPointerException: if the specified element is null

public E lower(E e)

Implements java.util.NavigableSet.lower.

Doc from java.util.NavigableSet.lower.

Returns the greatest element in this set strictly less than the given element, or null if there is no such element.

Parameters

e:E: the value to match

Returns:E

the greatest element less than e, or null if there is no such element

Exceptions

ClassCastException:: if the specified element cannot be compared with the elements currently in the set
NullPointerException:: if the specified element is null

pollFirst back to summary

pollFirst	back to summary
public E pollFirst() Implements java.util.NavigableSet.pollFirst. Doc from java.util.NavigableSet.pollFirst. Retrieves and removes the first (lowest) element, or returns `null` if this set is empty (optional operation). Returns:E the first element, or `null` if this set is empty

public E pollFirst()

Implements java.util.NavigableSet.pollFirst.

Doc from java.util.NavigableSet.pollFirst.

Retrieves and removes the first (lowest) element, or returns null if this set is empty (optional operation).

Returns:E: the first element, or null if this set is empty

pollLast back to summary

pollLast	back to summary
public E pollLast() Implements java.util.NavigableSet.pollLast. Doc from java.util.NavigableSet.pollLast. Retrieves and removes the last (highest) element, or returns `null` if this set is empty (optional operation). Returns:E the last element, or `null` if this set is empty

public E pollLast()

Implements java.util.NavigableSet.pollLast.

Doc from java.util.NavigableSet.pollLast.

Retrieves and removes the last (highest) element, or returns null if this set is empty (optional operation).

Returns:E: the last element, or null if this set is empty

remove back to summary

remove	back to summary
public boolean remove(Object o) Overrides java.util.AbstractCollection.remove. Implements java.util.Set.remove, java.util.Collection.remove. Removes the specified element from this set if it is present. More formally, removes an element `e` such that `o.equals(e)`, if this set contains such an element. Returns `true` if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.) Parameters o:Object object to be removed from this set, if present Returns:boolean `true` if this set contained the specified element Exceptions ClassCastException: if `o` cannot be compared with the elements currently in this set NullPointerException: if the specified element is null

public boolean remove(Object o)

Overrides java.util.AbstractCollection.remove.

Implements java.util.Set.remove, java.util.Collection.remove.

Removes the specified element from this set if it is present. More formally, removes an element e such that o.equals(e), if this set contains such an element. Returns true if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.)

Parameters

o:Object: object to be removed from this set, if present

Returns:boolean

true if this set contained the specified element

Exceptions

ClassCastException:: if o cannot be compared with the elements currently in this set
NullPointerException:: if the specified element is null

removeAll back to summary

removeAll	back to summary
public boolean removeAll(Collection<?> c) Overrides java.util.AbstractSet.removeAll. Implements java.util.Set.removeAll, java.util.Collection.removeAll. Removes from this set all of its elements that are contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets. Parameters c:Collection<?> collection containing elements to be removed from this set Returns:boolean `true` if this set changed as a result of the call Exceptions ClassCastException: if the class of an element of this set is incompatible with the specified collection (optional) NullPointerException: if the specified collection or any of its elements are null

public boolean removeAll(Collection<?> c)

Overrides java.util.AbstractSet.removeAll.

Implements java.util.Set.removeAll, java.util.Collection.removeAll.

Removes from this set all of its elements that are contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

Parameters

c:Collection<?>: collection containing elements to be removed from this set

Returns:boolean

true if this set changed as a result of the call

Exceptions

ClassCastException:: if the class of an element of this set is incompatible with the specified collection (optional)
NullPointerException:: if the specified collection or any of its elements are null

setMap	back to summary
private void setMap(ConcurrentNavigableMap<E, Object> map) Initializes map field; for use in clone.

size back to summary

size	back to summary
public int size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Set.size, java.util.Collection.size. Returns the number of elements in this set. If this set contains more than `Integer.MAX_VALUE` elements, it returns `Integer.MAX_VALUE`. Beware that, unlike in most collections, this method is NOT a constant-time operation. Because of the asynchronous nature of these sets, determining the current number of elements requires traversing them all to count them. Additionally, it is possible for the size to change during execution of this method, in which case the returned result will be inaccurate. Thus, this method is typically not very useful in concurrent applications. Returns:int the number of elements in this set

public int size()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.Set.size, java.util.Collection.size.

Returns the number of elements in this set. If this set contains more than Integer.MAX_VALUE elements, it returns Integer.MAX_VALUE.

Beware that, unlike in most collections, this method is NOT a constant-time operation. Because of the asynchronous nature of these sets, determining the current number of elements requires traversing them all to count them. Additionally, it is possible for the size to change during execution of this method, in which case the returned result will be inaccurate. Thus, this method is typically not very useful in concurrent applications.

Returns:int: the number of elements in this set

spliterator back to summary

spliterator	back to summary
public Spliterator<E> spliterator() Overrides default java.util.SortedSet.spliterator, java.util.Set.spliterator, java.util.Collection.spliterator. Returns a `Spliterator` over the elements in this set. The `Spliterator` reports `Spliterator#CONCURRENT`, `Spliterator#NONNULL`, `Spliterator#DISTINCT`, `Spliterator#SORTED` and `Spliterator#ORDERED`, with an encounter order that is ascending order. Overriding implementations should document the reporting of additional characteristic values. The spliterator's comparator is `null` if the set's comparator is `null`. Otherwise, the spliterator's comparator is the same as or imposes the same total ordering as the set's comparator. Returns:Spliterator<E> a `Spliterator` over the elements in this set Since 1.8

public Spliterator<E> spliterator()

Overrides default java.util.SortedSet.spliterator, java.util.Set.spliterator, java.util.Collection.spliterator.

Returns a Spliterator over the elements in this set.

The Spliterator reports Spliterator#CONCURRENT, Spliterator#NONNULL, Spliterator#DISTINCT, Spliterator#SORTED and Spliterator#ORDERED, with an encounter order that is ascending order. Overriding implementations should document the reporting of additional characteristic values.

The spliterator's comparator is null if the set's comparator is null. Otherwise, the spliterator's comparator is the same as or imposes the same total ordering as the set's comparator.

Returns:Spliterator<E>: a Spliterator over the elements in this set
Since: 1.8

subSet back to summary

subSet	back to summary
public NavigableSet<E> subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive) Implements java.util.NavigableSet.subSet. Doc from java.util.NavigableSet.subSet. Returns a view of the portion of this set whose elements range from `fromElement` to `toElement`. If `fromElement` and `toElement` are equal, the returned set is empty unless `fromInclusive` and `toInclusive` are both true. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports. The returned set will throw an `IllegalArgumentException` on an attempt to insert an element outside its range. Parameters fromElement:E low endpoint of the returned set fromInclusive:boolean `true` if the low endpoint is to be included in the returned view toElement:E high endpoint of the returned set toInclusive:boolean `true` if the high endpoint is to be included in the returned view Returns:NavigableSet<E> a view of the portion of this set whose elements range from `fromElement`, inclusive, to `toElement`, exclusive Exceptions ClassCastException: if `fromElement` and `toElement` cannot be compared to one another using this set's comparator (or, if the set has no comparator, using natural ordering). Implementations may, but are not required to, throw this exception if `fromElement` or `toElement` cannot be compared to elements currently in the set. NullPointerException: if `fromElement` or `toElement` is null IllegalArgumentException: if `fromElement` is greater than `toElement`; or if this set itself has a restricted range, and `fromElement` or `toElement` lies outside the bounds of the range.

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

Implements java.util.NavigableSet.subSet.

Doc from java.util.NavigableSet.subSet.

Returns a view of the portion of this set whose elements range from fromElement to toElement. If fromElement and toElement are equal, the returned set is empty unless fromInclusive and toInclusive are both true. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

Parameters

fromElement:E: low endpoint of the returned set
fromInclusive:boolean: true if the low endpoint is to be included in the returned view
toElement:E: high endpoint of the returned set
toInclusive:boolean: true if the high endpoint is to be included in the returned view

Returns:NavigableSet<E>

a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive

Exceptions

ClassCastException:: if fromElement and toElement cannot be compared to one another using this set's comparator (or, if the set has no comparator, using natural ordering). Implementations may, but are not required to, throw this exception if fromElement or toElement cannot be compared to elements currently in the set.
NullPointerException:: if fromElement or toElement is null
IllegalArgumentException:: if fromElement is greater than toElement; or if this set itself has a restricted range, and fromElement or toElement lies outside the bounds of the range.

subSet back to summary

subSet	back to summary
public NavigableSet<E> subSet(E fromElement, E toElement) Implements java.util.NavigableSet.subSet. Doc from java.util.NavigableSet.subSet. Returns a view of the portion of this set whose elements range from `fromElement`, inclusive, to `toElement`, exclusive. (If `fromElement` and `toElement` are equal, the returned set is empty.) The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports. The returned set will throw an `IllegalArgumentException` on an attempt to insert an element outside its range. Equivalent to `subSet(fromElement, true, toElement, false)`. Parameters fromElement:E Doc from java.util.SortedSet.subSet. low endpoint (inclusive) of the returned set toElement:E Doc from java.util.SortedSet.subSet. high endpoint (exclusive) of the returned set Returns:NavigableSet<E> Doc from java.util.SortedSet.subSet. a view of the portion of this set whose elements range from `fromElement`, inclusive, to `toElement`, exclusive Exceptions ClassCastException: if `fromElement` and `toElement` cannot be compared to one another using this set's comparator (or, if the set has no comparator, using natural ordering). Implementations may, but are not required to, throw this exception if `fromElement` or `toElement` cannot be compared to elements currently in the set. NullPointerException: if `fromElement` or `toElement` is null IllegalArgumentException: if `fromElement` is greater than `toElement`; or if this set itself has a restricted range, and `fromElement` or `toElement` lies outside the bounds of the range

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

Implements java.util.NavigableSet.subSet.

Doc from java.util.NavigableSet.subSet.

Returns a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive. (If fromElement and toElement are equal, the returned set is empty.) The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

Equivalent to subSet(fromElement, true, toElement, false).

Parameters

fromElement:E

Doc from java.util.SortedSet.subSet.

low endpoint (inclusive) of the returned set

toElement:E

Doc from java.util.SortedSet.subSet.

high endpoint (exclusive) of the returned set

Returns:NavigableSet<E>

Doc from java.util.SortedSet.subSet.

a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive

Exceptions

ClassCastException:: if fromElement and toElement cannot be compared to one another using this set's comparator (or, if the set has no comparator, using natural ordering). Implementations may, but are not required to, throw this exception if fromElement or toElement cannot be compared to elements currently in the set.
NullPointerException:: if fromElement or toElement is null
IllegalArgumentException:: if fromElement is greater than toElement; or if this set itself has a restricted range, and fromElement or toElement lies outside the bounds of the range

tailSet back to summary

tailSet	back to summary
public NavigableSet<E> tailSet(E fromElement, boolean inclusive) Implements java.util.NavigableSet.tailSet. Doc from java.util.NavigableSet.tailSet. Returns a view of the portion of this set whose elements are greater than (or equal to, if `inclusive` is true) `fromElement`. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports. The returned set will throw an `IllegalArgumentException` on an attempt to insert an element outside its range. Parameters fromElement:E low endpoint of the returned set inclusive:boolean `true` if the low endpoint is to be included in the returned view Returns:NavigableSet<E> a view of the portion of this set whose elements are greater than or equal to `fromElement` Exceptions ClassCastException: if `fromElement` is not compatible with this set's comparator (or, if the set has no comparator, if `fromElement` does not implement `Comparable`). Implementations may, but are not required to, throw this exception if `fromElement` cannot be compared to elements currently in the set. NullPointerException: if `fromElement` is null IllegalArgumentException: if this set itself has a restricted range, and `fromElement` lies outside the bounds of the range

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

Implements java.util.NavigableSet.tailSet.

Doc from java.util.NavigableSet.tailSet.

Returns a view of the portion of this set whose elements are greater than (or equal to, if inclusive is true) fromElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

Parameters

fromElement:E: low endpoint of the returned set
inclusive:boolean: true if the low endpoint is to be included in the returned view

Returns:NavigableSet<E>

a view of the portion of this set whose elements are greater than or equal to fromElement

Exceptions

ClassCastException:: if fromElement is not compatible with this set's comparator (or, if the set has no comparator, if fromElement does not implement Comparable). Implementations may, but are not required to, throw this exception if fromElement cannot be compared to elements currently in the set.
NullPointerException:: if fromElement is null
IllegalArgumentException:: if this set itself has a restricted range, and fromElement lies outside the bounds of the range

tailSet back to summary

tailSet	back to summary
public NavigableSet<E> tailSet(E fromElement) Implements java.util.NavigableSet.tailSet. Doc from java.util.NavigableSet.tailSet. Returns a view of the portion of this set whose elements are greater than or equal to `fromElement`. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports. The returned set will throw an `IllegalArgumentException` on an attempt to insert an element outside its range. Equivalent to `tailSet(fromElement, true)`. Parameters fromElement:E Doc from java.util.SortedSet.tailSet. low endpoint (inclusive) of the returned set Returns:NavigableSet<E> Doc from java.util.SortedSet.tailSet. a view of the portion of this set whose elements are greater than or equal to `fromElement` Exceptions ClassCastException: if `fromElement` is not compatible with this set's comparator (or, if the set has no comparator, if `fromElement` does not implement `Comparable`). Implementations may, but are not required to, throw this exception if `fromElement` cannot be compared to elements currently in the set. NullPointerException: if `fromElement` is null IllegalArgumentException: if this set itself has a restricted range, and `fromElement` lies outside the bounds of the range

public NavigableSet<E> tailSet(E fromElement)

Implements java.util.NavigableSet.tailSet.

Doc from java.util.NavigableSet.tailSet.

Returns a view of the portion of this set whose elements are greater than or equal to fromElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

Equivalent to tailSet(fromElement, true).

Parameters

fromElement:E

Doc from java.util.SortedSet.tailSet.

low endpoint (inclusive) of the returned set

Returns:NavigableSet<E>

Doc from java.util.SortedSet.tailSet.

a view of the portion of this set whose elements are greater than or equal to fromElement

Exceptions

ClassCastException:: if fromElement is not compatible with this set's comparator (or, if the set has no comparator, if fromElement does not implement Comparable). Implementations may, but are not required to, throw this exception if fromElement cannot be compared to elements currently in the set.
NullPointerException:: if fromElement is null
IllegalArgumentException:: if this set itself has a restricted range, and fromElement lies outside the bounds of the range

public Class ConcurrentSkipListSet<E>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail