--- jsr166/src/jsr166x/ConcurrentSkipListSet.java 2010/11/29 20:58:06 1.11
+++ jsr166/src/jsr166x/ConcurrentSkipListSet.java 2013/01/16 00:53:17 1.18
@@ -1,7 +1,7 @@
/*
* Written by Doug Lea with assistance from members of JCP JSR-166
* Expert Group and released to the public domain, as explained at
- * http://creativecommons.org/licenses/publicdomain
+ * http://creativecommons.org/publicdomain/zero/1.0/
*/
package jsr166x;
@@ -15,10 +15,10 @@ import java.util.concurrent.*;
* ascending order, sorted according to the natural order for
* the element's class (see {@link Comparable}), or by the comparator
* provided at creation time, depending on which constructor is
- * used.
+ * used.
*
- * This implementation provides expected average log(n) time
- * cost for the contains, add, and remove
+ *
This implementation provides expected average log(n) time
+ * cost for the {@code contains}, {@code add}, and {@code remove}
* operations and their variants. Insertion, removal, and access
* operations safely execute concurrently by multiple
* threads. Iterators are weakly consistent, returning elements
@@ -27,21 +27,21 @@ import java.util.concurrent.*;
* ConcurrentModificationException}, and may proceed concurrently with
* other operations.
*
- *
Beware that, unlike in most collections, the size
+ *
Beware that, unlike in most collections, the {@code 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. Additionally, the
- * bulk operations addAll, removeAll,
- * <retainAll, and tt>containsAll are not
+ * bulk operations {@code addAll}, {@code removeAll},
+ * {@code retainAll}, and {@code containsAll} are not
* guaranteed to be performed atomically. For example, an iterator
- * operating concurrently with an addAll operation might view
+ * operating concurrently with an {@code addAll} operation might view
* only some of the added elements.
*
*
This class and its iterators implement all of the
* optional methods of the {@link Set} and {@link 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
+ * this class does not permit the use of {@code null} elements.
+ * because {@code null} arguments and return values cannot be reliably
* distinguished from the absence of elements.
*
* @author Doug Lea
@@ -75,7 +75,7 @@ public class ConcurrentSkipListSet
* comparator.
*
* @param c the comparator that will be used to sort this set. A
- * null value indicates that the elements' natural
+ * {@code null} value indicates that the elements' natural
* ordering should be used.
*/
public ConcurrentSkipListSet(Comparator super E> c) {
@@ -86,12 +86,12 @@ public class ConcurrentSkipListSet
* Constructs a new set containing the elements in the specified
* collection, sorted according to the elements' natural order.
*
- * @param c The elements that will comprise the new set.
+ * @param c The elements that will comprise the new set
*
* @throws ClassCastException if the elements in the specified
- * collection are not comparable, or are not mutually comparable.
+ * collection are not comparable, or are not mutually comparable
* @throws NullPointerException if the specified collection is
- * null.
+ * {@code null}
*/
public ConcurrentSkipListSet(Collection extends E> c) {
m = new ConcurrentSkipListMap();
@@ -102,9 +102,9 @@ public class ConcurrentSkipListSet
* Constructs a new set containing the same elements as the specified
* sorted set, sorted according to the same ordering.
*
- * @param s sorted set whose elements will comprise the new set.
+ * @param s sorted set whose elements will comprise the new set
* @throws NullPointerException if the specified sorted set is
- * null.
+ * {@code null}
*/
public ConcurrentSkipListSet(SortedSet s) {
m = new ConcurrentSkipListMap(s.comparator());
@@ -115,7 +115,7 @@ public class ConcurrentSkipListSet
* Returns a shallow copy of this set. (The elements themselves
* are not cloned.)
*
- * @return a shallow copy of this set.
+ * @return a shallow copy of this set
*/
public Object clone() {
ConcurrentSkipListSet clone = null;
@@ -134,8 +134,8 @@ public class ConcurrentSkipListSet
/**
* Returns the number of elements in this set. If this set
- * contains more than Integer.MAX_VALUE elements, it
- * returns Integer.MAX_VALUE.
+ * contains more than {@code Integer.MAX_VALUE} elements, it
+ * returns {@code Integer.MAX_VALUE}.
*
* Beware that, unlike in most collections, this method is
* NOT a constant-time operation. Because of the
@@ -146,29 +146,29 @@ public class ConcurrentSkipListSet
* will be inaccurate. Thus, this method is typically not very
* useful in concurrent applications.
*
- * @return the number of elements in this set.
+ * @return the number of elements in this set
*/
public int size() {
return m.size();
}
/**
- * Returns true if this set contains no elements.
- * @return true if this set contains no elements.
+ * Returns {@code true} if this set contains no elements.
+ * @return {@code true} if this set contains no elements
*/
public boolean isEmpty() {
return m.isEmpty();
}
/**
- * Returns true if this set contains the specified element.
+ * Returns {@code true} if this set contains the specified element.
*
- * @param o the object to be checked for containment in this set.
- * @return true if this set contains the specified element.
+ * @param o the object to be checked for containment in this set
+ * @return {@code true} if this set contains the specified element
*
* @throws ClassCastException if the specified object cannot be compared
- * with the elements currently in the set.
- * @throws NullPointerException if o is null.
+ * with the elements currently in the set
+ * @throws NullPointerException if o is {@code null}
*/
public boolean contains(Object o) {
return m.containsKey(o);
@@ -177,13 +177,13 @@ public class ConcurrentSkipListSet
/**
* Adds the specified element to this set if it is not already present.
*
- * @param o element to be added to this set.
- * @return true if the set did not already contain the specified
- * element.
+ * @param o element to be added to this set
+ * @return {@code true} if the set did not already contain the specified
+ * element
*
* @throws ClassCastException if the specified object cannot be compared
- * with the elements currently in the set.
- * @throws NullPointerException if o is null.
+ * with the elements currently in the set
+ * @throws NullPointerException if o is {@code null}
*/
public boolean add(E o) {
return m.putIfAbsent(o, Boolean.TRUE) == null;
@@ -192,12 +192,12 @@ public class ConcurrentSkipListSet
/**
* Removes the specified element from this set if it is present.
*
- * @param o object to be removed from this set, if present.
- * @return true if the set contained the specified element.
+ * @param o object to be removed from this set, if present
+ * @return {@code true} if the set contained the specified element
*
* @throws ClassCastException if the specified object cannot be compared
- * with the elements currently in the set.
- * @throws NullPointerException if o is null.
+ * with the elements currently in the set
+ * @throws NullPointerException if o is {@code null}
*/
public boolean remove(Object o) {
return m.removep(o);
@@ -214,7 +214,7 @@ public class ConcurrentSkipListSet
* Returns an iterator over the elements in this set. The elements
* are returned in ascending order.
*
- * @return an iterator over the elements in this set.
+ * @return an iterator over the elements in this set
*/
public Iterator iterator() {
return m.keyIterator();
@@ -224,7 +224,7 @@ public class ConcurrentSkipListSet
* Returns an iterator over the elements in this set. The elements
* are returned in descending order.
*
- * @return an iterator over the elements in this set.
+ * @return an iterator over the elements in this set
*/
public Iterator descendingIterator() {
return m.descendingKeyIterator();
@@ -234,15 +234,15 @@ public class ConcurrentSkipListSet
/**
* Compares the specified object with this set for equality. Returns
- * true if the specified object is also a set, the two sets
+ * {@code 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.
*
- * @param o Object to be compared for equality with this set.
- * @return true if the specified Object is equal to this set.
+ * @param o Object to be compared for equality with this set
+ * @return {@code true} if the specified Object is equal to this set
*/
public boolean equals(Object o) {
// Override AbstractSet version to avoid calling size()
@@ -253,7 +253,7 @@ public class ConcurrentSkipListSet
Collection c = (Collection) o;
try {
return containsAll(c) && c.containsAll(this);
- } catch (ClassCastException unused) {
+ } catch (ClassCastException unused) {
return false;
} catch (NullPointerException unused) {
return false;
@@ -267,13 +267,13 @@ public class ConcurrentSkipListSet
* value is the asymmetric set difference of the two sets.
*
* @param c collection that defines which elements will be removed from
- * this set.
- * @return true if this set changed as a result of the call.
+ * this set
+ * @return {@code 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 collection
* @throws NullPointerException if the specified collection, or any
- * of its elements are null.
+ * of its elements are {@code null}
*/
public boolean removeAll(Collection> c) {
// Override AbstractSet version to avoid unnecessary call to size()
@@ -288,14 +288,14 @@ public class ConcurrentSkipListSet
/**
* Returns an element greater than or equal to the given element, or
- * null if there is no such element.
+ * {@code null} if there is no such element.
*
* @param o the value to match
* @return an element greater than or equal to given element, or
- * null if there is no such element.
+ * {@code null} if there is no such element
* @throws ClassCastException if o cannot be compared with the elements
- * currently in the set.
- * @throws NullPointerException if o is null
+ * currently in the set
+ * @throws NullPointerException if o is {@code null}
*/
public E ceiling(E o) {
return m.ceilingKey(o);
@@ -303,14 +303,14 @@ public class ConcurrentSkipListSet
/**
* Returns an element strictly less than the given element, or
- * null if there is no such element.
+ * {@code null} if there is no such element.
*
* @param o the value to match
* @return the greatest element less than the given element, or
- * null if there is no such element.
+ * {@code null} if there is no such element
* @throws ClassCastException if o cannot be compared with the elements
- * currently in the set.
- * @throws NullPointerException if o is null.
+ * currently in the set
+ * @throws NullPointerException if o is {@code null}
*/
public E lower(E o) {
return m.lowerKey(o);
@@ -318,14 +318,14 @@ public class ConcurrentSkipListSet
/**
* Returns an element less than or equal to the given element, or
- * null if there is no such element.
+ * {@code null} if there is no such element.
*
* @param o the value to match
* @return the greatest element less than or equal to given
- * element, or null if there is no such element.
+ * element, or {@code null} if there is no such element
* @throws ClassCastException if o cannot be compared with the elements
- * currently in the set.
- * @throws NullPointerException if o is null.
+ * currently in the set
+ * @throws NullPointerException if o is {@code null}
*/
public E floor(E o) {
return m.floorKey(o);
@@ -333,14 +333,14 @@ public class ConcurrentSkipListSet
/**
* Returns an element strictly greater than the given element, or
- * null if there is no such element.
+ * {@code null} if there is no such element.
*
* @param o the value to match
* @return the least element greater than the given element, or
- * null if there is no such element.
+ * {@code null} if there is no such element
* @throws ClassCastException if o cannot be compared with the elements
- * currently in the set.
- * @throws NullPointerException if o is null.
+ * currently in the set
+ * @throws NullPointerException if o is {@code null}
*/
public E higher(E o) {
return m.higherKey(o);
@@ -349,7 +349,7 @@ public class ConcurrentSkipListSet
/**
* Retrieves and removes the first (lowest) element.
*
- * @return the least element, or null if empty.
+ * @return the least element, or {@code null} if empty
*/
public E pollFirst() {
return m.pollFirstKey();
@@ -358,7 +358,7 @@ public class ConcurrentSkipListSet
/**
* Retrieves and removes the last (highest) element.
*
- * @return the last element, or null if empty.
+ * @return the last element, or {@code null} if empty
*/
public E pollLast() {
return m.pollLastKey();
@@ -369,11 +369,11 @@ public class ConcurrentSkipListSet
/**
- * Returns the comparator used to order this set, or null
+ * Returns the comparator used to order this set, or {@code null}
* if this set uses its elements natural ordering.
*
- * @return the comparator used to order this set, or null
- * if this set uses its elements natural ordering.
+ * @return the comparator used to order this set, or {@code null}
+ * if this set uses its elements natural ordering
*/
public Comparator super E> comparator() {
return m.comparator();
@@ -382,8 +382,8 @@ public class ConcurrentSkipListSet
/**
* Returns the first (lowest) element currently in this set.
*
- * @return the first (lowest) element currently in this set.
- * @throws NoSuchElementException sorted set is empty.
+ * @return the first (lowest) element currently in this set
+ * @throws NoSuchElementException sorted set is empty
*/
public E first() {
return m.firstKey();
@@ -392,8 +392,8 @@ public class ConcurrentSkipListSet
/**
* Returns the last (highest) element currently in this set.
*
- * @return the last (highest) element currently in this set.
- * @throws NoSuchElementException sorted set is empty.
+ * @return the last (highest) element currently in this set
+ * @throws NoSuchElementException sorted set is empty
*/
public E last() {
return m.lastKey();
@@ -403,24 +403,24 @@ public class ConcurrentSkipListSet
/**
* 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
+ * {@code fromElement}, inclusive, to {@code toElement}, exclusive. (If
+ * {@code fromElement} and {@code toElement} are equal, the returned
* sorted set is empty.) The returned sorted set is backed by this set,
* so changes in the returned sorted set are reflected in this set, and
* vice-versa.
- * @param fromElement low endpoint (inclusive) of the subSet.
- * @param toElement high endpoint (exclusive) of the subSet.
+ * @param fromElement low endpoint (inclusive) of the subSet
+ * @param toElement high endpoint (exclusive) of the subSet
* @return 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
+ * {@code fromElement}, inclusive, to {@code toElement},
+ * exclusive
+ * @throws ClassCastException if {@code fromElement} and
+ * {@code toElement} cannot be compared to one another using
* this set's comparator (or, if the set has no comparator,
- * using natural ordering).
- * @throws IllegalArgumentException if fromElement is
- * greater than toElement.
- * @throws NullPointerException if fromElement or
- * toElement is null.
+ * using natural ordering)
+ * @throws IllegalArgumentException if {@code fromElement} is
+ * greater than {@code toElement}
+ * @throws NullPointerException if {@code fromElement} or
+ * {@code toElement} is {@code null}
*/
public NavigableSet subSet(E fromElement, E toElement) {
return new ConcurrentSkipListSubSet(m, fromElement, toElement);
@@ -428,16 +428,16 @@ public class ConcurrentSkipListSet
/**
* Returns a view of the portion of this set whose elements are strictly
- * less than toElement. The returned sorted set is backed by
+ * less than {@code toElement}. The returned sorted set is backed by
* this set, so changes in the returned sorted set are reflected in this
* set, and vice-versa.
- * @param toElement high endpoint (exclusive) of the headSet.
+ * @param toElement high endpoint (exclusive) of the headSet
* @return a view of the portion of this set whose elements are strictly
- * less than toElement.
- * @throws ClassCastException if toElement is not compatible
+ * less than toElement
+ * @throws ClassCastException if {@code toElement} is not compatible
* with this set's comparator (or, if the set has no comparator,
- * if toElement does not implement Comparable).
- * @throws NullPointerException if toElement is null.
+ * if {@code toElement} does not implement {@code Comparable})
+ * @throws NullPointerException if {@code toElement} is {@code null}
*/
public NavigableSet headSet(E toElement) {
return new ConcurrentSkipListSubSet(m, null, toElement);
@@ -446,17 +446,17 @@ public class ConcurrentSkipListSet
/**
* Returns a view of the portion of this set whose elements are
- * greater than or equal to fromElement. The returned
+ * greater than or equal to {@code fromElement}. The returned
* sorted set is backed by this set, so changes in the returned
* sorted set are reflected in this set, and vice-versa.
- * @param fromElement low endpoint (inclusive) of the tailSet.
+ * @param fromElement low endpoint (inclusive) of the tailSet
* @return a view of the portion of this set whose elements are
- * greater than or equal to fromElement.
- * @throws ClassCastException if fromElement is not
+ * greater than or equal to {@code fromElement}
+ * @throws ClassCastException if {@code fromElement} is not
* compatible with this set's comparator (or, if the set has no
- * comparator, if fromElement does not implement
- * Comparable).
- * @throws NullPointerException if fromElement is null.
+ * comparator, if {@code fromElement} does not implement
+ * {@code Comparable})
+ * @throws NullPointerException if {@code fromElement} is {@code null}
*/
public NavigableSet tailSet(E fromElement) {
return new ConcurrentSkipListSubSet(m, fromElement, null);
@@ -469,9 +469,8 @@ public class ConcurrentSkipListSet
* underlying sets, differing in that elements outside their range are
* ignored, and attempts to add elements outside their ranges result
* in {@link IllegalArgumentException}. Instances of this class are
- * constructed only using the subSet, headSet, and
- * tailSet methods of their underlying sets.
- *
+ * constructed only using the {@code subSet}, {@code headSet}, and
+ * {@code tailSet} methods of their underlying sets.
*/
static class ConcurrentSkipListSubSet
extends AbstractSet
@@ -484,8 +483,8 @@ public class ConcurrentSkipListSet
/**
* Creates a new submap.
- * @param fromElement inclusive least value, or null if from start
- * @param toElement exclusive upper bound or null if to end
+ * @param fromElement inclusive least value, or {@code null} if from start
+ * @param toElement exclusive upper bound or {@code null} if to end
* @throws IllegalArgumentException if fromElement and toElement
* non-null and fromElement greater than toElement
*/