--- jsr166/src/test/tck/PriorityQueueTest.java	2003/09/20 18:20:08	1.5
+++ jsr166/src/test/tck/PriorityQueueTest.java	2009/11/02 20:28:31	1.9
@@ -1,8 +1,9 @@
 /*
- * Written by members of JCP JSR-166 Expert Group and released to the
- * public domain. Use, modify, and redistribute this code in any way
- * without acknowledgement. Other contributors include Andrew Wright,
- * Jeffrey Hayes, Pat Fischer, Mike Judd.
+ * 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
+ * Other contributors include Andrew Wright, Jeffrey Hayes,
+ * Pat Fisher, Mike Judd.
  */
 
 import junit.framework.*;
@@ -11,16 +12,14 @@ import java.util.concurrent.*;
 import java.io.*;
 
 public class PriorityQueueTest extends JSR166TestCase {
-
     public static void main(String[] args) {
-	junit.textui.TestRunner.run (suite());	
+	junit.textui.TestRunner.run (suite());
     }
-
     public static Test suite() {
 	return new TestSuite(PriorityQueueTest.class);
     }
 
-    static class MyReverseComparator implements Comparator { 
+    static class MyReverseComparator implements Comparator {
         public int compare(Object x, Object y) {
             int i = ((Integer)x).intValue();
             int j = ((Integer)y).intValue();
@@ -30,7 +29,6 @@ public class PriorityQueueTest extends J
         }
     }
 
-
     /**
      * Create a queue of given size containing consecutive
      * Integers 0 ... n.
@@ -46,16 +44,16 @@ public class PriorityQueueTest extends J
 	assertEquals(n, q.size());
         return q;
     }
- 
+
     /**
-     *
+     * A new queue has unbounded capacity
      */
     public void testConstructor1() {
         assertEquals(0, new PriorityQueue(SIZE).size());
     }
 
     /**
-     *
+     * Constructor throws IAE if  capacity argument nonpositive
      */
     public void testConstructor2() {
         try {
@@ -66,10 +64,9 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * Initializing from null Collection throws NPE
      */
     public void testConstructor3() {
-
         try {
             PriorityQueue q = new PriorityQueue((Collection)null);
             shouldThrow();
@@ -78,7 +75,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * Initializing from Collection of null elements throws NPE
      */
     public void testConstructor4() {
         try {
@@ -90,7 +87,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * Initializing from Collection with some null elements throws NPE
      */
     public void testConstructor5() {
         try {
@@ -104,7 +101,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * Queue contains all elements of collection used to initialize
      */
     public void testConstructor6() {
         try {
@@ -119,7 +116,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * The comparator used in constructor is used
      */
     public void testConstructor7() {
         try {
@@ -137,7 +134,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * isEmpty is true before add, false after
      */
     public void testEmpty() {
         PriorityQueue q = new PriorityQueue(2);
@@ -151,7 +148,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * size changes when elements added and removed
      */
     public void testSize() {
         PriorityQueue q = populatedQueue(SIZE);
@@ -166,27 +163,38 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * offer(null) throws NPE
      */
     public void testOfferNull() {
 	try {
             PriorityQueue q = new PriorityQueue(1);
             q.offer(null);
             shouldThrow();
-        } catch (NullPointerException success) { }   
+        } catch (NullPointerException success) { }
     }
 
     /**
-     *
+     * add(null) throws NPE
+     */
+    public void testAddNull() {
+	try {
+            PriorityQueue q = new PriorityQueue(1);
+            q.add(null);
+            shouldThrow();
+        } catch (NullPointerException success) { }
+    }
+
+    /**
+     * Offer of comparable element succeeds
      */
     public void testOffer() {
         PriorityQueue q = new PriorityQueue(1);
-        assertTrue(q.offer(new Integer(0)));
-        assertTrue(q.offer(new Integer(1)));
+        assertTrue(q.offer(zero));
+        assertTrue(q.offer(one));
     }
 
     /**
-     *
+     * Offer of non-Comparable throws CCE
      */
     public void testOfferNonComparable() {
         try {
@@ -200,7 +208,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * add of comparable succeeds
      */
     public void testAdd() {
         PriorityQueue q = new PriorityQueue(SIZE);
@@ -211,7 +219,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * addAll(null) throws NPE
      */
     public void testAddAll1() {
         try {
@@ -222,7 +230,7 @@ public class PriorityQueueTest extends J
         catch (NullPointerException success) {}
     }
     /**
-     *
+     * addAll of a collection with null elements throws NPE
      */
     public void testAddAll2() {
         try {
@@ -234,7 +242,8 @@ public class PriorityQueueTest extends J
         catch (NullPointerException success) {}
     }
     /**
-     *
+     * addAll of a collection with any null elements throws NPE after
+     * possibly adding some elements
      */
     public void testAddAll3() {
         try {
@@ -249,7 +258,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * Queue contains all elements of successful addAll
      */
     public void testAddAll5() {
         try {
@@ -267,7 +276,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * poll succeeds unless empty
      */
     public void testPoll() {
         PriorityQueue q = populatedQueue(SIZE);
@@ -278,7 +287,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * peek returns next element, or null if empty
      */
     public void testPeek() {
         PriorityQueue q = populatedQueue(SIZE);
@@ -292,7 +301,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * element returns next element, or throws NSEE if empty
      */
     public void testElement() {
         PriorityQueue q = populatedQueue(SIZE);
@@ -308,7 +317,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * remove removes next element, or throws NSEE if empty
      */
     public void testRemove() {
         PriorityQueue q = populatedQueue(SIZE);
@@ -319,11 +328,11 @@ public class PriorityQueueTest extends J
             q.remove();
             shouldThrow();
         } catch (NoSuchElementException success){
-	}   
+	}
     }
 
     /**
-     *
+     * remove(x) removes x and returns true if present
      */
     public void testRemoveElement() {
         PriorityQueue q = populatedQueue(SIZE);
@@ -336,9 +345,9 @@ public class PriorityQueueTest extends J
         }
         assertTrue(q.isEmpty());
     }
-	
+
     /**
-     *
+     * contains(x) reports true when elements added but not yet removed
      */
     public void testContains() {
         PriorityQueue q = populatedQueue(SIZE);
@@ -350,7 +359,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * clear removes all elements
      */
     public void testClear() {
         PriorityQueue q = populatedQueue(SIZE);
@@ -364,7 +373,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * containsAll(c) is true when c contains a subset of elements
      */
     public void testContainsAll() {
         PriorityQueue q = populatedQueue(SIZE);
@@ -378,7 +387,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * retainAll(c) retains only those elements of c and reports true if changed
      */
     public void testRetainAll() {
         PriorityQueue q = populatedQueue(SIZE);
@@ -397,7 +406,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * removeAll(c) removes only those elements of c and reports true if changed
      */
     public void testRemoveAll() {
         for (int i = 1; i < SIZE; ++i) {
@@ -413,7 +422,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * toArray contains all elements
      */
     public void testToArray() {
         PriorityQueue q = populatedQueue(SIZE);
@@ -424,7 +433,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * toArray(a) contains all elements
      */
     public void testToArray2() {
         PriorityQueue q = populatedQueue(SIZE);
@@ -434,9 +443,9 @@ public class PriorityQueueTest extends J
         for(int i = 0; i < ints.length; i++)
             assertEquals(ints[i], q.poll());
     }
-    
+
     /**
-     *
+     * iterator iterates through all elements
      */
     public void testIterator() {
         PriorityQueue q = populatedQueue(SIZE);
@@ -450,7 +459,7 @@ public class PriorityQueueTest extends J
     }
 
     /**
-     *
+     * iterator.remove removes current element
      */
     public void testIteratorRemove () {
         final PriorityQueue q = new PriorityQueue(3);
@@ -470,7 +479,7 @@ public class PriorityQueueTest extends J
 
 
     /**
-     *
+     * toString contains toStrings of elements
      */
     public void testToString() {
         PriorityQueue q = populatedQueue(SIZE);
@@ -478,10 +487,10 @@ public class PriorityQueueTest extends J
         for (int i = 0; i < SIZE; ++i) {
             assertTrue(s.indexOf(String.valueOf(i)) >= 0);
         }
-    }        
+    }
 
     /**
-     *
+     * A deserialized serialized queue has same elements
      */
     public void testSerialization() {
         PriorityQueue q = populatedQueue(SIZE);
@@ -495,7 +504,7 @@ public class PriorityQueueTest extends J
             ObjectInputStream in = new ObjectInputStream(new BufferedInputStream(bin));
             PriorityQueue r = (PriorityQueue)in.readObject();
             assertEquals(q.size(), r.size());
-            while (!q.isEmpty()) 
+            while (!q.isEmpty())
                 assertEquals(q.remove(), r.remove());
         } catch(Exception e){
             unexpectedException();