- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractSet<E>
-
- java.util.concurrent.ConcurrentSkipListSet<E>
-
- Type Parameters:
E- the type of elements maintained by this set
- All Implemented Interfaces:
- Serializable, Cloneable, Iterable<E>, Collection<E>, NavigableSet<E>, Set<E>, SortedSet<E>
public class ConcurrentSkipListSet<E> extends AbstractSet<E> implements NavigableSet<E>, Cloneable, Serializable
A scalable concurrentNavigableSetimplementation based on aConcurrentSkipListMap. The elements of the set are kept sorted according to their natural ordering, or by aComparatorprovided 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
SetandIteratorinterfaces. 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
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description ConcurrentSkipListSet()Constructs a new, empty set that orders its elements according to their natural ordering.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.ConcurrentSkipListSet(Comparator<? super E> comparator)Constructs a new, empty set that orders its elements according to the specified comparator.ConcurrentSkipListSet(SortedSet<E> s)Constructs a new set containing the same elements and using the same ordering as the specified sorted set.
-
Method Summary
Methods Modifier and Type Method and Description booleanadd(E e)Adds the specified element to this set if it is not already present.Eceiling(E e)Returns the least element in this set greater than or equal to the given element, ornullif there is no such element.voidclear()Removes all of the elements from this set.ConcurrentSkipListSet<E>clone()Returns a shallow copy of this ConcurrentSkipListSet instance.Comparator<? super E>comparator()Returns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.booleancontains(Object o)Returns true if this set contains the specified element.Iterator<E>descendingIterator()Returns an iterator over the elements in this set in descending order.NavigableSet<E>descendingSet()Returns a reverse order view of the elements contained in this set.booleanequals(Object o)Compares the specified object with this set for equality.Efirst()Returns the first (lowest) element currently in this set.Efloor(E e)Returns the greatest element in this set less than or equal to the given element, ornullif there is no such element.NavigableSet<E>headSet(E toElement)Returns a view of the portion of this set whose elements are strictly less than toElement.NavigableSet<E>headSet(E toElement, boolean inclusive)Returns a view of the portion of this set whose elements are less than (or equal to, ifinclusiveis true)toElement.Ehigher(E e)Returns the least element in this set strictly greater than the given element, ornullif there is no such element.booleanisEmpty()Returns true if this set contains no elements.Iterator<E>iterator()Returns an iterator over the elements in this set in ascending order.Elast()Returns the last (highest) element currently in this set.Elower(E e)Returns the greatest element in this set strictly less than the given element, ornullif there is no such element.EpollFirst()Retrieves and removes the first (lowest) element, or returnsnullif this set is empty.EpollLast()Retrieves and removes the last (highest) element, or returnsnullif this set is empty.booleanremove(Object o)Removes the specified element from this set if it is present.booleanremoveAll(Collection<?> c)Removes from this set all of its elements that are contained in the specified collection.intsize()Returns the number of elements in this set.NavigableSet<E>subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)Returns a view of the portion of this set whose elements range fromfromElementtotoElement.NavigableSet<E>subSet(E fromElement, E toElement)Returns a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive.NavigableSet<E>tailSet(E fromElement)Returns a view of the portion of this set whose elements are greater than or equal to fromElement.NavigableSet<E>tailSet(E fromElement, boolean inclusive)Returns a view of the portion of this set whose elements are greater than (or equal to, ifinclusiveis true)fromElement.-
Methods inherited from class java.util.AbstractSet
hashCode
-
Methods inherited from class java.util.AbstractCollection
addAll, containsAll, retainAll, toArray, toArray, toString
-
-
-
-
Constructor Detail
-
ConcurrentSkipListSet
public ConcurrentSkipListSet()
Constructs a new, empty set that orders its elements according to their natural ordering.
-
ConcurrentSkipListSet
public ConcurrentSkipListSet(Comparator<? super E> comparator)
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.
-
ConcurrentSkipListSet
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- The elements that will comprise the new set- Throws:
ClassCastException- if the elements in c are notComparable, or are not mutually comparableNullPointerException- if the specified collection or any of its elements are null
-
ConcurrentSkipListSet
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- sorted set whose elements will comprise the new set- Throws:
NullPointerException- if the specified sorted set or any of its elements are null
-
-
Method Detail
-
clone
public ConcurrentSkipListSet<E> clone()
Returns a shallow copy of this ConcurrentSkipListSet instance. (The elements themselves are not cloned.)
-
size
public int 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.
- Specified by:
sizein interfaceCollection<E>- Specified by:
sizein interfaceSet<E>- Specified by:
sizein classAbstractCollection<E>- Returns:
- the number of elements in this set
-
isEmpty
public boolean isEmpty()
Returns true if this set contains no elements.- Specified by:
isEmptyin interfaceCollection<E>- Specified by:
isEmptyin interfaceSet<E>- Overrides:
isEmptyin classAbstractCollection<E>- Returns:
- true if this set contains no elements
-
contains
public boolean contains(Object o)
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:
containsin interfaceCollection<E>- Specified by:
containsin interfaceSet<E>- Overrides:
containsin classAbstractCollection<E>- 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 setNullPointerException- if the specified element is null
-
add
public boolean add(E e)
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:
addin interfaceCollection<E>- Specified by:
addin interfaceSet<E>- Overrides:
addin classAbstractCollection<E>- Parameters:
e- element to be added to this set- Returns:
- true if this set did not already contain the specified element
- Throws:
ClassCastException- if e cannot be compared with the elements currently in this setNullPointerException- if the specified element is null
-
remove
public boolean remove(Object o)
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:
removein interfaceCollection<E>- Specified by:
removein interfaceSet<E>- Overrides:
removein classAbstractCollection<E>- Parameters:
o- object to be removed from this set, if present- Returns:
- true if this set contained the specified element
- Throws:
ClassCastException- if o cannot be compared with the elements currently in this setNullPointerException- if the specified element is null
-
clear
public void clear()
Removes all of the elements from this set.- Specified by:
clearin interfaceCollection<E>- Specified by:
clearin interfaceSet<E>- Overrides:
clearin classAbstractCollection<E>
-
iterator
public Iterator<E> iterator()
Returns an iterator over the elements in this set in ascending order.- Specified by:
iteratorin interfaceIterable<E>- Specified by:
iteratorin interfaceCollection<E>- Specified by:
iteratorin interfaceNavigableSet<E>- Specified by:
iteratorin interfaceSet<E>- Specified by:
iteratorin classAbstractCollection<E>- Returns:
- an iterator over the elements in this set in ascending order
-
descendingIterator
public Iterator<E> descendingIterator()
Returns an iterator over the elements in this set in descending order.- Specified by:
descendingIteratorin interfaceNavigableSet<E>- Returns:
- an iterator over the elements in this set in descending order
-
equals
public boolean equals(Object o)
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:
equalsin interfaceCollection<E>- Specified by:
equalsin interfaceSet<E>- Overrides:
equalsin classAbstractSet<E>- 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:
Object.hashCode(),HashMap
-
removeAll
public boolean removeAll(Collection<?> c)
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:
removeAllin interfaceCollection<E>- Specified by:
removeAllin interfaceSet<E>- Overrides:
removeAllin classAbstractSet<E>- Parameters:
c- collection containing elements to be removed from this set- Returns:
- true if this set changed as a result of the call
- Throws:
ClassCastException- if the types of one or more elements in this set are incompatible with the specified collectionNullPointerException- if the specified collection or any of its elements are null- See Also:
AbstractCollection.remove(Object),AbstractCollection.contains(Object)
-
lower
public E lower(E e)
Description copied from interface:NavigableSetReturns the greatest element in this set strictly less than the given element, ornullif there is no such element.- Specified by:
lowerin interfaceNavigableSet<E>- Parameters:
e- the value to match- Returns:
- the greatest element less than
e, ornullif there is no such element - Throws:
ClassCastException- if the specified element cannot be compared with the elements currently in the setNullPointerException- if the specified element is null
-
floor
public E floor(E e)
Description copied from interface:NavigableSetReturns the greatest element in this set less than or equal to the given element, ornullif there is no such element.- Specified by:
floorin interfaceNavigableSet<E>- Parameters:
e- the value to match- Returns:
- the greatest element less than or equal to
e, ornullif there is no such element - Throws:
ClassCastException- if the specified element cannot be compared with the elements currently in the setNullPointerException- if the specified element is null
-
ceiling
public E ceiling(E e)
Description copied from interface:NavigableSetReturns the least element in this set greater than or equal to the given element, ornullif there is no such element.- Specified by:
ceilingin interfaceNavigableSet<E>- Parameters:
e- the value to match- Returns:
- the least element greater than or equal to
e, ornullif there is no such element - Throws:
ClassCastException- if the specified element cannot be compared with the elements currently in the setNullPointerException- if the specified element is null
-
higher
public E higher(E e)
Description copied from interface:NavigableSetReturns the least element in this set strictly greater than the given element, ornullif there is no such element.- Specified by:
higherin interfaceNavigableSet<E>- Parameters:
e- the value to match- Returns:
- the least element greater than
e, ornullif there is no such element - Throws:
ClassCastException- if the specified element cannot be compared with the elements currently in the setNullPointerException- if the specified element is null
-
pollFirst
public E pollFirst()
Description copied from interface:NavigableSetRetrieves and removes the first (lowest) element, or returnsnullif this set is empty.- Specified by:
pollFirstin interfaceNavigableSet<E>- Returns:
- the first element, or
nullif this set is empty
-
pollLast
public E pollLast()
Description copied from interface:NavigableSetRetrieves and removes the last (highest) element, or returnsnullif this set is empty.- Specified by:
pollLastin interfaceNavigableSet<E>- Returns:
- the last element, or
nullif this set is empty
-
comparator
public Comparator<? super E> comparator()
Description copied from interface:SortedSetReturns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.- Specified by:
comparatorin interfaceSortedSet<E>- Returns:
- the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements
-
first
public E first()
Description copied from interface:SortedSetReturns the first (lowest) element currently in this set.- Specified by:
firstin interfaceSortedSet<E>- Returns:
- the first (lowest) element currently in this set
- Throws:
NoSuchElementException- if this set is empty
-
last
public E last()
Description copied from interface:SortedSetReturns the last (highest) element currently in this set.- Specified by:
lastin interfaceSortedSet<E>- Returns:
- the last (highest) element currently in this set
- Throws:
NoSuchElementException- if this set is empty
-
subSet
public NavigableSet<E> subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)
Description copied from interface:NavigableSetReturns a view of the portion of this set whose elements range fromfromElementtotoElement. IffromElementandtoElementare equal, the returned set is empty unlessfromInclusiveandtoInclusiveare 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
IllegalArgumentExceptionon an attempt to insert an element outside its range.- Specified by:
subSetin interfaceNavigableSet<E>- Parameters:
fromElement- low endpoint of the returned setfromInclusive-trueif the low endpoint is to be included in the returned viewtoElement- high endpoint of the returned settoInclusive-trueif 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, totoElement, exclusive - Throws:
ClassCastException- iffromElementandtoElementcannot 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 iffromElementortoElementcannot be compared to elements currently in the set.NullPointerException- iffromElementortoElementis nullIllegalArgumentException- iffromElementis greater thantoElement; or if this set itself has a restricted range, andfromElementortoElementlies outside the bounds of the range.
-
headSet
public NavigableSet<E> headSet(E toElement, boolean inclusive)
Description copied from interface:NavigableSetReturns a view of the portion of this set whose elements are less than (or equal to, ifinclusiveis 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
IllegalArgumentExceptionon an attempt to insert an element outside its range.- Specified by:
headSetin interfaceNavigableSet<E>- Parameters:
toElement- high endpoint of the returned setinclusive-trueif 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
inclusiveis true)toElement - Throws:
ClassCastException- iftoElementis not compatible with this set's comparator (or, if the set has no comparator, iftoElementdoes not implementComparable). Implementations may, but are not required to, throw this exception iftoElementcannot be compared to elements currently in the set.NullPointerException- iftoElementis nullIllegalArgumentException- if this set itself has a restricted range, andtoElementlies outside the bounds of the range
-
tailSet
public NavigableSet<E> tailSet(E fromElement, boolean inclusive)
Description copied from interface:NavigableSetReturns a view of the portion of this set whose elements are greater than (or equal to, ifinclusiveis 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
IllegalArgumentExceptionon an attempt to insert an element outside its range.- Specified by:
tailSetin interfaceNavigableSet<E>- Parameters:
fromElement- low endpoint of the returned setinclusive-trueif 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- iffromElementis not compatible with this set's comparator (or, if the set has no comparator, iffromElementdoes not implementComparable). Implementations may, but are not required to, throw this exception iffromElementcannot be compared to elements currently in the set.NullPointerException- iffromElementis nullIllegalArgumentException- if this set itself has a restricted range, andfromElementlies outside the bounds of the range
-
subSet
public NavigableSet<E> subSet(E fromElement, E toElement)
Description copied from interface:NavigableSetReturns 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:
subSetin interfaceNavigableSet<E>- Specified by:
subSetin interfaceSortedSet<E>- Parameters:
fromElement- low endpoint (inclusive) of the returned settoElement- 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.NullPointerException- iffromElementortoElementis nullIllegalArgumentException- 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
-
headSet
public NavigableSet<E> headSet(E toElement)
Description copied from interface:NavigableSetReturns 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:
headSetin interfaceNavigableSet<E>- Specified by:
headSetin interfaceSortedSet<E>- 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 implementComparable). Implementations may, but are not required to, throw this exception if toElement cannot be compared to elements currently in the set.NullPointerException- iftoElementis nullIllegalArgumentException- if this set itself has a restricted range, and toElement lies outside the bounds of the range na
-
tailSet
public NavigableSet<E> tailSet(E fromElement)
Description copied from interface:NavigableSetReturns 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:
tailSetin interfaceNavigableSet<E>- Specified by:
tailSetin interfaceSortedSet<E>- 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 implementComparable). Implementations may, but are not required to, throw this exception if fromElement cannot be compared to elements currently in the set.NullPointerException- iffromElementis nullIllegalArgumentException- if this set itself has a restricted range, and fromElement lies outside the bounds of the range
-
descendingSet
public NavigableSet<E> 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 expressions.descendingSet().descendingSet()returns a view ofsessentially equivalent tos.- Specified by:
descendingSetin interfaceNavigableSet<E>- Returns:
- a reverse order view of this set
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
05/10/2025 00:37:03 Cette version de la page est en cache (à la date du 05/10/2025 00:37:03) afin d'accélérer le traitement.Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.
Document créé le 11/06/2005, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-java/util/concurrent/concurrentskiplistset.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.