|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class ConcurrentSkipListSet<E>
java.util.concurrent.ConcurrentSkipListSet<E>
Type Parameters:
E - the type of elements maintained by this set
All Implemented Interfaces:
public class 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 and spliterators are
weakly consistent.
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.
Bulk operations that add, remove, or examine multiple elements,
such as AbstractCollection.addAll(Collection), Collection.removeIf(Predicate) or Iterable.forEach(Consumer),
are not guaranteed to be performed atomically.
For example, a forEach traversal concurrent with an
addAll operation might observe 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.
This class is a member of the
Java Collections Framework.
Since:
1.6
Author:
Doug Lea
See Also:
Constructor Summary |
Constructs a new, empty set that orders its elements according to
their natural ordering.
|
Constructs a new set containing the elements in the specified
collection, 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 same elements and using the
same ordering as the specified sorted set.
|
Method Summary |
boolean |
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.
|
void |
Removes all of the elements from this set.
|
|
Returns a shallow copy of this ConcurrentSkipListSet
instance.
|
|
Returns the comparator used to order the elements in this set,
or null if this set uses the natural ordering of its elements.
|
boolean |
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.
|
boolean |
Compares the specified object with this set for equality.
|
|
Returns the first (lowest) element currently in this set.
|
|
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 view of the portion of this set whose elements are
strictly less than toElement.
|
|
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.
|
boolean |
Returns true if this set contains no elements.
|
|
Returns an iterator over the elements in this set in ascending order.
|
|
Returns the last (highest) element currently in this set.
|
|
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.
|
boolean |
Removes the specified element from this set if it is present.
|
boolean |
Removes from this set all of its elements that are contained in
the specified collection.
|
int |
Returns the number of elements in this set.
|
|
|
|
subSet( E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)
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 range
from fromElement, inclusive, to toElement,
exclusive.
|
|
Returns a view of the portion of this set whose elements are
greater than or equal to fromElement.
|
|
tailSet( E fromElement, boolean inclusive)
Returns a view of the portion of this set whose elements are greater
than (or equal to, if inclusive is true) fromElement.
|
Methods inherited from class java.lang. Object |
|
Methods inherited from interface java.util. Collection |
|
Methods inherited from interface java.lang. Iterable |
|
Methods inherited from interface java.util. Set |
copyOf, of, of, of, of, of, of, of, of, of, of, of, of |
public ConcurrentSkipListSet |
() |
Constructs a new, empty set that orders its elements according to
their
natural ordering.
public ConcurrentSkipListSet |
|
Constructs a new, empty set that orders its elements according to
the specified comparator.
Parameters:
comparator - the comparator that will be used to order this set.
If
null, the
natural
ordering of the elements will be used.
public ConcurrentSkipListSet |
|
Constructs a new set containing the elements in the specified
collection, that orders its elements according to their
natural ordering.
Parameters:
c - The elements that will comprise the new set
Throws:
public ConcurrentSkipListSet |
|
Constructs a new set containing the same elements and using the
same ordering as the specified sorted set.
Parameters:
s - sorted set whose elements will comprise the new set
Throws:
Returns a shallow copy of this
ConcurrentSkipListSet
instance. (The elements themselves are not cloned.)
Overrides:
Returns:
a shallow copy of this set
See Also:
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.
Specified by:
Overrides:
Returns:
the number of elements in this set
public boolean isEmpty |
() |
Returns
true if this set contains no elements.
Specified by:
Overrides:
Returns:
true if this set contains no elements
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).
Specified by:
Overrides:
Parameters:
o - object to be checked for containment in this set
Returns:
true if this set contains the specified element
Throws:
ClassCastException - if the specified element cannot be
compared with the elements currently in this set
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.
Specified by:
Overrides:
Parameters:
e - element to be added to this set
Returns:
true if this set did not already contain the
specified element
Throws:
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.)
Specified by:
Overrides:
Parameters:
o - object to be removed from this set, if present
Returns:
true if this set contained the specified element
Throws:
Removes all of the elements from this set.
Specified by:
Overrides:
Returns an iterator over the elements in this set in ascending order.
Specified by:
Overrides:
Returns:
an iterator over the elements in this set in ascending order
Returns an iterator over the elements in this set in descending order.
Specified by:
Returns:
an iterator over the elements in this set in descending order
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.
Specified by:
Overrides:
Parameters:
o - the object to be compared for equality with this set
Returns:
true if the specified object is equal to this set
See Also:
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.
Specified by:
Overrides:
Parameters:
c - collection containing elements to be removed from this set
Returns:
true if this set changed as a result of the call
Throws:
See Also:
Returns the greatest element in this set strictly less than the
given element, or null if there is no such element.
Specified by:
Parameters:
e - the value to match
Returns:
the greatest element less than e,
or null if there is no such element
Throws:
ClassCastException - if the specified element cannot be
compared with the elements currently in the set
Returns the greatest element in this set less than or equal to
the given element, or null if there is no such element.
Specified by:
Parameters:
e - the value to match
Returns:
the greatest element less than or equal to e,
or null if there is no such element
Throws:
ClassCastException - if the specified element cannot be
compared with the elements currently in the set
Returns the least element in this set greater than or equal to
the given element, or null if there is no such element.
Specified by:
Parameters:
e - the value to match
Returns:
the least element greater than or equal to e,
or null if there is no such element
Throws:
ClassCastException - if the specified element cannot be
compared with the elements currently in the set
Returns the least element in this set strictly greater than the
given element, or null if there is no such element.
Specified by:
Parameters:
e - the value to match
Returns:
the least element greater than e,
or null if there is no such element
Throws:
ClassCastException - if the specified element cannot be
compared with the elements currently in the set
Retrieves and removes the first (lowest) element,
or returns null if this set is empty.
Specified by:
Returns:
the first element, or null if this set is empty
Retrieves and removes the last (highest) element,
or returns null if this set is empty.
Specified by:
Returns:
the last element, or null if this set is empty
Returns the comparator used to order the elements in this set,
or
null if this set uses the
natural ordering of its elements.
Specified by:
Returns:
the comparator used to order the elements in this set,
or null if this set uses the natural ordering
of its elements
Returns the first (lowest) element currently in this set.
Specified by:
Returns:
the first (lowest) element currently in this set
Throws:
Returns the last (highest) element currently in this set.
Specified by:
Returns:
the last (highest) element currently in this set
Throws:
|
( E fromElement, boolean fromInclusive, E toElement, boolean toInclusive) |
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.
Specified by:
Parameters:
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
Returns:
a view of the portion of this set whose elements range from
fromElement, inclusive, to toElement, exclusive
Throws:
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.
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.
|
( E toElement, boolean inclusive) |
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.
Specified by:
Parameters:
toElement - high endpoint of the returned set
inclusive - true if the high endpoint
is to be included in the returned view
Returns:
a view of the portion of this set whose elements are less than
(or equal to, if inclusive is true) toElement
Throws:
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.
IllegalArgumentException - if this set itself has a
restricted range, and
toElement lies outside the
bounds of the range
|
( E fromElement, boolean inclusive) |
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.
Specified by:
Parameters:
fromElement - low endpoint of the returned set
inclusive - true if the low endpoint
is to be included in the returned view
Returns:
a view of the portion of this set whose elements are greater
than or equal to fromElement
Throws:
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.
IllegalArgumentException - if this set itself has a
restricted range, and
fromElement lies outside the
bounds of the range
|
( E fromElement, E toElement) |
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).
Specified by:
Parameters:
fromElement - low endpoint (inclusive) of the returned set
toElement - high endpoint (exclusive) of the returned set
Returns:
a view of the portion of this set whose elements range from
fromElement, inclusive, to toElement, exclusive
Throws:
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.
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
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).
Specified by:
Parameters:
toElement - high endpoint (exclusive) of the returned set
Returns:
a view of the portion of this set whose elements are strictly
less than toElement
Throws:
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.
IllegalArgumentException - if this set itself has a
restricted range, and
toElement lies outside the
bounds of the range
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).
Specified by:
Parameters:
fromElement - low endpoint (inclusive) of the returned set
Returns:
a view of the portion of this set whose elements are greater
than or equal to fromElement
Throws:
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.
IllegalArgumentException - if this set itself has a
restricted range, and
fromElement lies outside the
bounds of the range
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.
Specified by:
Returns:
a reverse order view of this set
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz