java.lang.Object | |||
↳ | java.util.AbstractCollection<E> | ||
↳ | java.util.AbstractSet<E> | ||
↳ | java.util.concurrent.ConcurrentSkipListSet<E> |
A scalable concurrent NavigableSet
implementation based on
a ConcurrentSkipListMap
. The elements of the set are kept
sorted according to their natural ordering
,
or by a Comparator
provided at set creation time, depending
on which constructor is used.
This implementation provides expected average log(n) time
cost for the contains
, add
, and remove
operations and their variants. Insertion, removal, and access
operations safely execute concurrently by multiple threads.
Iterators are weakly consistent, returning elements
reflecting the state of the set at some point at or since the
creation of the iterator. They do not throw ConcurrentModificationException
, and may proceed concurrently with
other operations. Ascending ordered views and their iterators are
faster than descending ones.
Beware that, unlike in most collections, the size
method is not a constant-time operation. Because of the
asynchronous nature of these sets, determining the current number
of elements requires a traversal of the elements, and so may report
inaccurate results if this collection is modified during traversal.
Additionally, the bulk operations addAll
,
removeAll
, retainAll
, containsAll
,
equals
, and toArray
are not guaranteed
to be performed atomically. For example, an iterator operating
concurrently with an addAll
operation might view only some
of the added elements.
This class and its iterators implement all of the
optional methods of the Set
and Iterator
interfaces. Like most other concurrent collection implementations,
this class does not permit the use of null
elements,
because null
arguments and return values cannot be reliably
distinguished from the absence of elements.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a new, empty set that orders its elements according to
their
natural ordering . | |||||||||||
Constructs a new, empty set that orders its elements according to
the specified comparator.
| |||||||||||
Constructs a new set containing the elements in the specified
collection, that orders its elements according to their
natural ordering . | |||||||||||
Constructs a new set containing the same elements and using the
same ordering as the specified sorted set.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Adds the specified element to this set if it is not already present.
| |||||||||||
Returns the least element in this set greater than or equal to
the given element, or
null if there is no such element. | |||||||||||
Removes all of the elements from this set.
| |||||||||||
Returns a shallow copy of this
ConcurrentSkipListSet
instance. | |||||||||||
Returns the comparator used to compare elements in this
SortedSet . | |||||||||||
Returns
true if this set contains the specified element. | |||||||||||
Returns an iterator over the elements in this set in descending order.
| |||||||||||
Returns a reverse order view of the elements contained in this set.
| |||||||||||
Compares the specified object with this set for equality.
| |||||||||||
Returns the first element in this
SortedSet . | |||||||||||
Returns the greatest element in this set less than or equal to
the given element, or
null if there is no such element. | |||||||||||
Returns a
SortedSet of the specified portion of this
SortedSet which contains elements less than the end element.
Equivalent to | |||||||||||
Returns a view of the portion of this set whose elements are less than
(or equal to, if
inclusive is true) toElement . | |||||||||||
Returns the least element in this set strictly greater than the
given element, or
null if there is no such element. | |||||||||||
Returns
true if this set contains no elements. | |||||||||||
Returns an iterator over the elements in this set in ascending order.
| |||||||||||
Returns the last element in this
SortedSet . | |||||||||||
Returns the greatest element in this set strictly less than the
given element, or
null if there is no such element. | |||||||||||
Retrieves and removes the first (lowest) element,
or returns
null if this set is empty. | |||||||||||
Retrieves and removes the last (highest) element,
or returns
null if this set is empty. | |||||||||||
Removes the specified element from this set if it is present.
| |||||||||||
Removes from this set all of its elements that are contained in
the specified collection.
| |||||||||||
Returns the number of elements in this set.
| |||||||||||
Returns a
SortedSet of the specified portion of this
SortedSet which contains elements greater or equal to the start
element but less than the end element.
Equivalent to | |||||||||||
Returns a view of the portion of this set whose elements range from
fromElement to toElement . | |||||||||||
Returns a view of the portion of this set whose elements are greater
than (or equal to, if
inclusive is true) fromElement . | |||||||||||
Returns a
SortedSet of the specified portion of this
SortedSet which contains elements greater or equal to the start
element.
Equivalent to |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.util.AbstractSet
| |||||||||||
From class
java.util.AbstractCollection
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.lang.Iterable
| |||||||||||
From interface
java.util.Collection
| |||||||||||
From interface java.util.NavigableSet | |||||||||||
From interface
java.util.Set
| |||||||||||
From interface
java.util.SortedSet
|
Constructs a new, empty set that orders its elements according to
their natural ordering
.
Constructs a new, empty set that orders its elements according to the specified comparator.
comparator | the comparator that will be used to order this set.
If null , the natural
ordering of the elements will be used.
|
---|
Constructs a new set containing the elements in the specified
collection, that orders its elements according to their
natural ordering
.
c | The elements that will comprise the new set |
---|
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 |
Constructs a new set containing the same elements and using the same ordering as the specified sorted set.
s | sorted set whose elements will comprise the new set |
---|
NullPointerException | if the specified sorted set or any of its elements are null |
---|
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
.
e | element to be added to this set |
---|
true
if this set did not already contain the
specified elementClassCastException | if e cannot be compared
with the elements currently in this set |
---|---|
NullPointerException | if the specified element is null |
Returns the least element in this set greater than or equal to
the given element, or null
if there is no such element.
e | the value to match |
---|
e
,
or null
if there is no such elementClassCastException | |
---|---|
NullPointerException | if the specified element is null |
Returns a shallow copy of this ConcurrentSkipListSet
instance. (The elements themselves are not cloned.)
Returns the comparator used to compare elements in this SortedSet
.
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)
.
o | object to be checked for containment in this set |
---|
true
if this set contains the specified elementClassCastException | if the specified element cannot be compared with the elements currently in this set |
---|---|
NullPointerException | if the specified element is null |
Returns an iterator over the elements in this set in descending order.
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
.
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.
o | the object to be compared for equality with this set |
---|
true
if the specified object is equal to this set
Returns the first element in this SortedSet
. The first element
is the lowest element.
NoSuchElementException |
---|
Returns the greatest element in this set less than or equal to
the given element, or null
if there is no such element.
e | the value to match |
---|
e
,
or null
if there is no such elementClassCastException | |
---|---|
NullPointerException | if the specified element is null |
Returns a SortedSet
of the specified portion of this
SortedSet
which contains elements less than the end element. The
returned SortedSet
is backed by this SortedSet
so changes
to one set are reflected by the other.
Equivalent to headSet(toElement, false)
.
toElement | the end element. |
---|
end
.ClassCastException | |
---|---|
NullPointerException | if toElement is null |
IllegalArgumentException |
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.
toElement | high endpoint of the returned set |
---|---|
inclusive | true if the high endpoint
is to be included in the returned view |
inclusive
is true) toElement
ClassCastException | |
---|---|
NullPointerException | if toElement is null |
IllegalArgumentException |
Returns the least element in this set strictly greater than the
given element, or null
if there is no such element.
e | the value to match |
---|
e
,
or null
if there is no such elementClassCastException | |
---|---|
NullPointerException | if the specified element is null |
Returns true
if this set contains no elements.
true
if this set contains no elements
Returns an iterator over the elements in this set in ascending order.
Returns the last element in this SortedSet
. The last element is
the highest element.
NoSuchElementException |
---|
Returns the greatest element in this set strictly less than the
given element, or null
if there is no such element.
e | the value to match |
---|
e
,
or null
if there is no such elementClassCastException | |
---|---|
NullPointerException | if the specified element is null |
Retrieves and removes the first (lowest) element,
or returns null
if this set is empty.
null
if this set is empty
Retrieves and removes the last (highest) element,
or returns null
if this set is empty.
null
if this set is empty
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.)
o | object to be removed from this set, if present |
---|
true
if this set contained the specified elementClassCastException | if o cannot be compared
with the elements currently in this set |
---|---|
NullPointerException | if the specified element is null |
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.
c | collection containing elements to be removed from this set |
---|
true
if this set changed as a result of the callClassCastException | if the types of one or more elements in this set are incompatible with the specified collection |
---|---|
NullPointerException | if the specified collection or any of its elements are null |
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 a SortedSet
of the specified portion of this
SortedSet
which contains elements greater or equal to the start
element but less than the end element. The returned SortedSet
is
backed by this SortedMap so changes to one set are reflected by the
other.
Equivalent to subSet(fromElement, true, toElement, false)
.
fromElement | the start element. |
---|---|
toElement | the end element. |
start
and less than end
.ClassCastException | |
---|---|
NullPointerException | if fromElement or
toElement is null |
IllegalArgumentException |
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 fromExclusive
and toExclusive
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.
fromElement | low endpoint of the returned set |
---|---|
fromInclusive | true if the low endpoint
is to be included in the returned view |
toElement | high endpoint of the returned set |
toInclusive | true if the high endpoint
is to be included in the returned view |
fromElement
, inclusive, to toElement
, exclusiveClassCastException | |
---|---|
NullPointerException | if fromElement or
toElement is null |
IllegalArgumentException |
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.
fromElement | low endpoint of the returned set |
---|---|
inclusive | true if the low endpoint
is to be included in the returned view |
fromElement
ClassCastException | |
---|---|
NullPointerException | if fromElement is null |
IllegalArgumentException |
Returns a SortedSet
of the specified portion of this
SortedSet
which contains elements greater or equal to the start
element. The returned SortedSet
is backed by this
SortedSet
so changes to one set are reflected by the other.
Equivalent to tailSet(fromElement, true)
.
fromElement | the start element. |
---|
start
.ClassCastException | |
---|---|
NullPointerException | if fromElement is null |
IllegalArgumentException |