ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/jsr166x/ConcurrentSkipListSet.java
(Generate patch)

Comparing jsr166/src/jsr166x/ConcurrentSkipListSet.java (file contents):
Revision 1.6 by dl, Tue Mar 8 17:51:57 2005 UTC vs.
Revision 1.15 by jsr166, Sat Dec 29 23:55:19 2012 UTC

# Line 1 | Line 1
1   /*
2   * Written by Doug Lea with assistance from members of JCP JSR-166
3   * Expert Group and released to the public domain, as explained at
4 < * http://creativecommons.org/licenses/publicdomain
4 > * http://creativecommons.org/publicdomain/zero/1.0/
5   */
6  
7 < package jsr166x;
7 > package jsr166x;
8  
9   import java.util.*;
10   import java.util.concurrent.*;
# Line 60 | Line 60 | public class ConcurrentSkipListSet<E>
60       * fields of underlying map, but enables this field to be declared
61       * final, which is necessary for thread safety.
62       */
63 <    private final ConcurrentSkipListMap<E,Object> m;
63 >    private final ConcurrentSkipListMap<E,Object> m;
64  
65      /**
66       * Constructs a new, empty set, sorted according to the elements' natural
67 <     * order.
67 >     * order.
68       */
69      public ConcurrentSkipListSet() {
70          m = new ConcurrentSkipListMap<E,Object>();
# Line 72 | Line 72 | public class ConcurrentSkipListSet<E>
72  
73      /**
74       * Constructs a new, empty set, sorted according to the specified
75 <     * comparator.  
75 >     * comparator.
76       *
77       * @param c the comparator that will be used to sort this set.  A
78       *        <tt>null</tt> value indicates that the elements' <i>natural
# Line 86 | Line 86 | public class ConcurrentSkipListSet<E>
86       * Constructs a new set containing the elements in the specified
87       * collection, sorted according to the elements' <i>natural order</i>.
88       *
89 <     * @param c The elements that will comprise the new set.
89 >     * @param c The elements that will comprise the new set
90       *
91       * @throws ClassCastException if the elements in the specified
92 <     * collection are not comparable, or are not mutually comparable.
92 >     * collection are not comparable, or are not mutually comparable
93       * @throws NullPointerException if the specified collection is
94 <     * <tt>null</tt>.
94 >     * <tt>null</tt>
95       */
96      public ConcurrentSkipListSet(Collection<? extends E> c) {
97          m = new ConcurrentSkipListMap<E,Object>();
# Line 102 | Line 102 | public class ConcurrentSkipListSet<E>
102       * Constructs a new set containing the same elements as the specified
103       * sorted set, sorted according to the same ordering.
104       *
105 <     * @param s sorted set whose elements will comprise the new set.
105 >     * @param s sorted set whose elements will comprise the new set
106       * @throws NullPointerException if the specified sorted set is
107 <     * <tt>null</tt>.
107 >     * <tt>null</tt>
108       */
109      public ConcurrentSkipListSet(SortedSet<E> s) {
110          m = new ConcurrentSkipListMap<E,Object>(s.comparator());
# Line 115 | Line 115 | public class ConcurrentSkipListSet<E>
115       * Returns a shallow copy of this set. (The elements themselves
116       * are not cloned.)
117       *
118 <     * @return a shallow copy of this set.
118 >     * @return a shallow copy of this set
119       */
120      public Object clone() {
121          ConcurrentSkipListSet<E> clone = null;
122 <        try {
123 <            clone = (ConcurrentSkipListSet<E>) super.clone();
124 <        } catch (CloneNotSupportedException e) {
125 <            throw new InternalError();
126 <        }
122 >        try {
123 >            clone = (ConcurrentSkipListSet<E>) super.clone();
124 >        } catch (CloneNotSupportedException e) {
125 >            throw new InternalError();
126 >        }
127  
128          clone.m.initialize();
129          clone.addAll(this);
# Line 146 | Line 146 | public class ConcurrentSkipListSet<E>
146       * will be inaccurate. Thus, this method is typically not very
147       * useful in concurrent applications.
148       *
149 <     * @return  the number of elements in this set.
149 >     * @return  the number of elements in this set
150       */
151      public int size() {
152 <        return m.size();
152 >        return m.size();
153      }
154  
155      /**
156       * Returns <tt>true</tt> if this set contains no elements.
157 <     * @return <tt>true</tt> if this set contains no elements.
157 >     * @return <tt>true</tt> if this set contains no elements
158       */
159      public boolean isEmpty() {
160 <        return m.isEmpty();
160 >        return m.isEmpty();
161      }
162  
163      /**
164       * Returns <tt>true</tt> if this set contains the specified element.
165       *
166 <     * @param o the object to be checked for containment in this set.
167 <     * @return <tt>true</tt> if this set contains the specified element.
166 >     * @param o the object to be checked for containment in this set
167 >     * @return <tt>true</tt> if this set contains the specified element
168       *
169       * @throws ClassCastException if the specified object cannot be compared
170 <     *            with the elements currently in the set.
171 <     * @throws NullPointerException if o is <tt>null</tt>.
170 >     *            with the elements currently in the set
171 >     * @throws NullPointerException if o is <tt>null</tt>
172       */
173      public boolean contains(Object o) {
174 <        return m.containsKey(o);
174 >        return m.containsKey(o);
175      }
176  
177      /**
178       * Adds the specified element to this set if it is not already present.
179       *
180 <     * @param o element to be added to this set.
180 >     * @param o element to be added to this set
181       * @return <tt>true</tt> if the set did not already contain the specified
182 <     *         element.
182 >     *         element
183       *
184       * @throws ClassCastException if the specified object cannot be compared
185 <     *            with the elements currently in the set.
186 <     * @throws NullPointerException if o is <tt>null</tt>.
185 >     *            with the elements currently in the set
186 >     * @throws NullPointerException if o is <tt>null</tt>
187       */
188      public boolean add(E o) {
189 <        return m.putIfAbsent(o, Boolean.TRUE) == null;
189 >        return m.putIfAbsent(o, Boolean.TRUE) == null;
190      }
191  
192      /**
193       * Removes the specified element from this set if it is present.
194       *
195 <     * @param o object to be removed from this set, if present.
196 <     * @return <tt>true</tt> if the set contained the specified element.
195 >     * @param o object to be removed from this set, if present
196 >     * @return <tt>true</tt> if the set contained the specified element
197       *
198       * @throws ClassCastException if the specified object cannot be compared
199 <     *            with the elements currently in the set.
200 <     * @throws NullPointerException if o is <tt>null</tt>.
199 >     *            with the elements currently in the set
200 >     * @throws NullPointerException if o is <tt>null</tt>
201       */
202      public boolean remove(Object o) {
203 <        return m.removep(o);
203 >        return m.removep(o);
204      }
205  
206      /**
207       * Removes all of the elements from this set.
208       */
209      public void clear() {
210 <        m.clear();
210 >        m.clear();
211      }
212  
213      /**
214       * Returns an iterator over the elements in this set.  The elements
215       * are returned in ascending order.
216       *
217 <     * @return an iterator over the elements in this set.
217 >     * @return an iterator over the elements in this set
218       */
219      public Iterator<E> iterator() {
220 <        return m.keyIterator();
220 >        return m.keyIterator();
221      }
222  
223      /**
224       * Returns an iterator over the elements in this set.  The elements
225       * are returned in descending order.
226       *
227 <     * @return an iterator over the elements in this set.
227 >     * @return an iterator over the elements in this set
228       */
229      public Iterator<E> descendingIterator() {
230 <        return m.descendingKeyIterator();
230 >        return m.descendingKeyIterator();
231      }
232  
233      /* ---------------- AbstractSet Overrides -------------- */
# Line 241 | Line 241 | public class ConcurrentSkipListSet<E>
241       * equals method works properly across different implementations of the
242       * set interface.
243       *
244 <     * @param o Object to be compared for equality with this set.
245 <     * @return <tt>true</tt> if the specified Object is equal to this set.
244 >     * @param o Object to be compared for equality with this set
245 >     * @return <tt>true</tt> if the specified Object is equal to this set
246       */
247      public boolean equals(Object o) {
248          // Override AbstractSet version to avoid calling size()
249 <        if (o == this)
250 <            return true;
251 <        if (!(o instanceof Set))
252 <            return false;
253 <        Collection c = (Collection) o;
249 >        if (o == this)
250 >            return true;
251 >        if (!(o instanceof Set))
252 >            return false;
253 >        Collection c = (Collection) o;
254          try {
255              return containsAll(c) && c.containsAll(this);
256 <        } catch(ClassCastException unused)   {
256 >        } catch (ClassCastException unused) {
257              return false;
258 <        } catch(NullPointerException unused) {
258 >        } catch (NullPointerException unused) {
259              return false;
260          }
261      }
262 <    
262 >
263      /**
264       * Removes from this set all of its elements that are contained in
265       * the specified collection.  If the specified collection is also
# Line 267 | Line 267 | public class ConcurrentSkipListSet<E>
267       * value is the <i>asymmetric set difference</i> of the two sets.
268       *
269       * @param  c collection that defines which elements will be removed from
270 <     *           this set.
271 <     * @return <tt>true</tt> if this set changed as a result of the call.
272 <     *
270 >     *           this set
271 >     * @return <tt>true</tt> if this set changed as a result of the call
272 >     *
273       * @throws ClassCastException if the types of one or more elements in this
274       *            set are incompatible with the specified collection
275       * @throws NullPointerException if the specified collection, or any
276 <     * of its elements are <tt>null</tt>.
276 >     * of its elements are <tt>null</tt>
277       */
278      public boolean removeAll(Collection<?> c) {
279          // Override AbstractSet version to avoid unnecessary call to size()
# Line 283 | Line 283 | public class ConcurrentSkipListSet<E>
283                  modified = true;
284          return modified;
285      }
286 <    
286 >
287      /* ---------------- Relational operations -------------- */
288  
289      /**
290       * Returns an element greater than or equal to the given element, or
291       * <tt>null</tt> if there is no such element.
292 <     *
292 >     *
293       * @param o the value to match
294       * @return an element greater than or equal to given element, or
295 <     * <tt>null</tt> if there is no such element.
295 >     * <tt>null</tt> if there is no such element
296       * @throws ClassCastException if o cannot be compared with the elements
297 <     *            currently in the set.
297 >     *            currently in the set
298       * @throws NullPointerException if o is <tt>null</tt>
299       */
300      public E ceiling(E o) {
# Line 304 | Line 304 | public class ConcurrentSkipListSet<E>
304      /**
305       * Returns an element strictly less than the given element, or
306       * <tt>null</tt> if there is no such element.
307 <     *
307 >     *
308       * @param o the value to match
309       * @return the greatest element less than the given element, or
310 <     * <tt>null</tt> if there is no such element.
310 >     * <tt>null</tt> if there is no such element
311       * @throws ClassCastException if o cannot be compared with the elements
312 <     *            currently in the set.
313 <     * @throws NullPointerException if o is <tt>null</tt>.
312 >     *            currently in the set
313 >     * @throws NullPointerException if o is <tt>null</tt>
314       */
315      public E lower(E o) {
316          return m.lowerKey(o);
# Line 319 | Line 319 | public class ConcurrentSkipListSet<E>
319      /**
320       * Returns an element less than or equal to the given element, or
321       * <tt>null</tt> if there is no such element.
322 <     *
322 >     *
323       * @param o the value to match
324       * @return the greatest element less than or equal to given
325 <     * element, or <tt>null</tt> if there is no such element.
325 >     * element, or <tt>null</tt> if there is no such element
326       * @throws ClassCastException if o cannot be compared with the elements
327 <     *            currently in the set.
328 <     * @throws NullPointerException if o is <tt>null</tt>.
327 >     *            currently in the set
328 >     * @throws NullPointerException if o is <tt>null</tt>
329       */
330      public E floor(E o) {
331          return m.floorKey(o);
# Line 334 | Line 334 | public class ConcurrentSkipListSet<E>
334      /**
335       * Returns an element strictly greater than the given element, or
336       * <tt>null</tt> if there is no such element.
337 <     *
337 >     *
338       * @param o the value to match
339       * @return the least element greater than the given element, or
340 <     * <tt>null</tt> if there is no such element.
340 >     * <tt>null</tt> if there is no such element
341       * @throws ClassCastException if o cannot be compared with the elements
342 <     *            currently in the set.
343 <     * @throws NullPointerException if o is <tt>null</tt>.
342 >     *            currently in the set
343 >     * @throws NullPointerException if o is <tt>null</tt>
344       */
345      public E higher(E o) {
346          return m.higherKey(o);
# Line 349 | Line 349 | public class ConcurrentSkipListSet<E>
349      /**
350       * Retrieves and removes the first (lowest) element.
351       *
352 <     * @return the least element, or <tt>null</tt> if empty.
352 >     * @return the least element, or <tt>null</tt> if empty
353       */
354      public E pollFirst() {
355          return m.pollFirstKey();
# Line 358 | Line 358 | public class ConcurrentSkipListSet<E>
358      /**
359       * Retrieves and removes the last (highest) element.
360       *
361 <     * @return the last element, or <tt>null</tt> if empty.
361 >     * @return the last element, or <tt>null</tt> if empty
362       */
363      public E pollLast() {
364          return m.pollLastKey();
# Line 373 | Line 373 | public class ConcurrentSkipListSet<E>
373       * if this set uses its elements natural ordering.
374       *
375       * @return the comparator used to order this set, or <tt>null</tt>
376 <     * if this set uses its elements natural ordering.
376 >     * if this set uses its elements natural ordering
377       */
378      public Comparator<? super E> comparator() {
379          return m.comparator();
# Line 382 | Line 382 | public class ConcurrentSkipListSet<E>
382      /**
383       * Returns the first (lowest) element currently in this set.
384       *
385 <     * @return the first (lowest) element currently in this set.
386 <     * @throws    NoSuchElementException sorted set is empty.
385 >     * @return the first (lowest) element currently in this set
386 >     * @throws    NoSuchElementException sorted set is empty
387       */
388      public E first() {
389          return m.firstKey();
# Line 392 | Line 392 | public class ConcurrentSkipListSet<E>
392      /**
393       * Returns the last (highest) element currently in this set.
394       *
395 <     * @return the last (highest) element currently in this set.
396 <     * @throws    NoSuchElementException sorted set is empty.
395 >     * @return the last (highest) element currently in this set
396 >     * @throws    NoSuchElementException sorted set is empty
397       */
398      public E last() {
399          return m.lastKey();
# Line 407 | Line 407 | public class ConcurrentSkipListSet<E>
407       * <tt>fromElement</tt> and <tt>toElement</tt> are equal, the returned
408       * sorted set is empty.)  The returned sorted set is backed by this set,
409       * so changes in the returned sorted set are reflected in this set, and
410 <     * vice-versa.
411 <     * @param fromElement low endpoint (inclusive) of the subSet.
412 <     * @param toElement high endpoint (exclusive) of the subSet.
410 >     * vice-versa.
411 >     * @param fromElement low endpoint (inclusive) of the subSet
412 >     * @param toElement high endpoint (exclusive) of the subSet
413       * @return a view of the portion of this set whose elements range from
414 <     *         <tt>fromElement</tt>, inclusive, to <tt>toElement</tt>,
415 <     *         exclusive.
414 >     *         <tt>fromElement</tt>, inclusive, to <tt>toElement</tt>,
415 >     *         exclusive
416       * @throws ClassCastException if <tt>fromElement</tt> and
417       *         <tt>toElement</tt> cannot be compared to one another using
418       *         this set's comparator (or, if the set has no comparator,
419 <     *         using natural ordering).
419 >     *         using natural ordering)
420       * @throws IllegalArgumentException if <tt>fromElement</tt> is
421 <     * greater than <tt>toElement</tt>.
421 >     * greater than <tt>toElement</tt>
422       * @throws NullPointerException if <tt>fromElement</tt> or
423 <     *         <tt>toElement</tt> is <tt>null</tt>.
423 >     *         <tt>toElement</tt> is <tt>null</tt>
424       */
425      public NavigableSet<E> subSet(E fromElement, E toElement) {
426 <        return new ConcurrentSkipListSubSet<E>(m, fromElement, toElement);
426 >        return new ConcurrentSkipListSubSet<E>(m, fromElement, toElement);
427      }
428  
429      /**
430       * Returns a view of the portion of this set whose elements are strictly
431       * less than <tt>toElement</tt>.  The returned sorted set is backed by
432       * this set, so changes in the returned sorted set are reflected in this
433 <     * set, and vice-versa.  
434 <     * @param toElement high endpoint (exclusive) of the headSet.
433 >     * set, and vice-versa.
434 >     * @param toElement high endpoint (exclusive) of the headSet
435       * @return a view of the portion of this set whose elements are strictly
436 <     *         less than toElement.
436 >     *         less than toElement
437       * @throws ClassCastException if <tt>toElement</tt> is not compatible
438       *         with this set's comparator (or, if the set has no comparator,
439 <     *         if <tt>toElement</tt> does not implement <tt>Comparable</tt>).
440 <     * @throws NullPointerException if <tt>toElement</tt> is <tt>null</tt>.
439 >     *         if <tt>toElement</tt> does not implement <tt>Comparable</tt>)
440 >     * @throws NullPointerException if <tt>toElement</tt> is <tt>null</tt>
441       */
442      public NavigableSet<E> headSet(E toElement) {
443 <        return new ConcurrentSkipListSubSet<E>(m, null, toElement);
443 >        return new ConcurrentSkipListSubSet<E>(m, null, toElement);
444      }
445  
446  
# Line 449 | Line 449 | public class ConcurrentSkipListSet<E>
449       * greater than or equal to <tt>fromElement</tt>.  The returned
450       * sorted set is backed by this set, so changes in the returned
451       * sorted set are reflected in this set, and vice-versa.
452 <     * @param fromElement low endpoint (inclusive) of the tailSet.
452 >     * @param fromElement low endpoint (inclusive) of the tailSet
453       * @return a view of the portion of this set whose elements are
454 <     * greater than or equal to <tt>fromElement</tt>.
454 >     * greater than or equal to <tt>fromElement</tt>
455       * @throws ClassCastException if <tt>fromElement</tt> is not
456       * compatible with this set's comparator (or, if the set has no
457       * comparator, if <tt>fromElement</tt> does not implement
458 <     * <tt>Comparable</tt>).
459 <     * @throws NullPointerException if <tt>fromElement</tt> is <tt>null</tt>.
458 >     * <tt>Comparable</tt>)
459 >     * @throws NullPointerException if <tt>fromElement</tt> is <tt>null</tt>
460       */
461      public NavigableSet<E> tailSet(E fromElement) {
462 <        return new ConcurrentSkipListSubSet<E>(m, fromElement, null);
462 >        return new ConcurrentSkipListSubSet<E>(m, fromElement, null);
463      }
464  
465      /**
# Line 471 | Line 471 | public class ConcurrentSkipListSet<E>
471       * in {@link IllegalArgumentException}.  Instances of this class are
472       * constructed only using the <tt>subSet</tt>, <tt>headSet</tt>, and
473       * <tt>tailSet</tt> methods of their underlying sets.
474     *
474       */
475 <    static class ConcurrentSkipListSubSet<E>
476 <        extends AbstractSet<E>
475 >    static class ConcurrentSkipListSubSet<E>
476 >        extends AbstractSet<E>
477          implements NavigableSet<E>, java.io.Serializable {
478  
479          private static final long serialVersionUID = -7647078645896651609L;
480  
481          /** The underlying submap  */
482          private final ConcurrentSkipListMap.ConcurrentSkipListSubMap<E,Object> s;
483 <        
483 >
484          /**
485 <         * Creates a new submap.
485 >         * Creates a new submap.
486           * @param fromElement inclusive least value, or <tt>null</tt> if from start
487           * @param toElement exclusive upper bound or <tt>null</tt> if to end
488           * @throws IllegalArgumentException if fromElement and toElement
489 <         * nonnull and fromElement greater than toElement
489 >         * non-null and fromElement greater than toElement
490           */
491 <        ConcurrentSkipListSubSet(ConcurrentSkipListMap<E,Object> map,
491 >        ConcurrentSkipListSubSet(ConcurrentSkipListMap<E,Object> map,
492                                   E fromElement, E toElement) {
493              s = new ConcurrentSkipListMap.ConcurrentSkipListSubMap<E,Object>
494                  (map, fromElement, toElement);
# Line 500 | Line 499 | public class ConcurrentSkipListSet<E>
499          public NavigableSet<E> subSet(E fromElement, E toElement) {
500              if (!s.inOpenRange(fromElement) || !s.inOpenRange(toElement))
501                  throw new IllegalArgumentException("element out of range");
502 <            return new ConcurrentSkipListSubSet<E>(s.getMap(),
502 >            return new ConcurrentSkipListSubSet<E>(s.getMap(),
503                                                     fromElement, toElement);
504          }
505  
# Line 508 | Line 507 | public class ConcurrentSkipListSet<E>
507              E least = s.getLeast();
508              if (!s.inOpenRange(toElement))
509                  throw new IllegalArgumentException("element out of range");
510 <            return new ConcurrentSkipListSubSet<E>(s.getMap(),
510 >            return new ConcurrentSkipListSubSet<E>(s.getMap(),
511                                                     least, toElement);
512          }
513 <        
513 >
514          public NavigableSet<E> tailSet(E fromElement) {
515              E fence = s.getFence();
516              if (!s.inOpenRange(fromElement))
517                  throw new IllegalArgumentException("element out of range");
518 <            return new ConcurrentSkipListSubSet<E>(s.getMap(),
518 >            return new ConcurrentSkipListSubSet<E>(s.getMap(),
519                                                     fromElement, fence);
520          }
521  
# Line 539 | Line 538 | public class ConcurrentSkipListSet<E>
538          public Iterator<E> descendingIterator() {
539              return s.descendingKeySet().iterator();
540          }
541 <        public E pollFirst() {
541 >        public E pollFirst() {
542              Map.Entry<E,?> e = s.pollFirstEntry();
543 <            return (e == null)? null : e.getKey();
543 >            return (e == null) ? null : e.getKey();
544          }
545          public E pollLast() {
546              Map.Entry<E,?> e = s.pollLastEntry();
547 <            return (e == null)? null : e.getKey();
547 >            return (e == null) ? null : e.getKey();
548          }
549  
550      }
551 < }    
551 > }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines