--- jsr166/src/test/tck/PriorityQueueTest.java	2003/08/31 19:24:55	1.1
+++ jsr166/src/test/tck/PriorityQueueTest.java	2003/09/20 18:20:08	1.5
@@ -8,13 +8,9 @@
 import junit.framework.*;
 import java.util.*;
 import java.util.concurrent.*;
+import java.io.*;
 
-public class PriorityQueueTest extends TestCase {
-
-    private static final int N = 10;
-    private static final long SHORT_DELAY_MS = 100; 
-    private static final long MEDIUM_DELAY_MS = 1000;
-    private static final long LONG_DELAY_MS = 10000; 
+public class PriorityQueueTest extends JSR166TestCase {
 
     public static void main(String[] args) {
 	junit.textui.TestRunner.run (suite());	
@@ -39,7 +35,7 @@ public class PriorityQueueTest extends T
      * Create a queue of given size containing consecutive
      * Integers 0 ... n.
      */
-    private PriorityQueue fullQueue(int n) {
+    private PriorityQueue populatedQueue(int n) {
         PriorityQueue q = new PriorityQueue(n);
         assertTrue(q.isEmpty());
 	for(int i = n-1; i >= 0; i-=2)
@@ -51,72 +47,98 @@ public class PriorityQueueTest extends T
         return q;
     }
  
-    public void testConstructor1(){
-        assertEquals(0, new PriorityQueue(N).size());
+    /**
+     *
+     */
+    public void testConstructor1() {
+        assertEquals(0, new PriorityQueue(SIZE).size());
     }
 
-    public void testConstructor2(){
+    /**
+     *
+     */
+    public void testConstructor2() {
         try {
             PriorityQueue q = new PriorityQueue(0);
-            fail("Cannot make zero-sized");
+            shouldThrow();
         }
         catch (IllegalArgumentException success) {}
     }
 
+    /**
+     *
+     */
     public void testConstructor3() {
 
         try {
             PriorityQueue q = new PriorityQueue((Collection)null);
-            fail("Cannot make from null collection");
+            shouldThrow();
         }
         catch (NullPointerException success) {}
     }
 
-    public void testConstructor4(){
+    /**
+     *
+     */
+    public void testConstructor4() {
         try {
-            Integer[] ints = new Integer[N];
+            Integer[] ints = new Integer[SIZE];
             PriorityQueue q = new PriorityQueue(Arrays.asList(ints));
-            fail("Cannot make with null elements");
+            shouldThrow();
         }
         catch (NullPointerException success) {}
     }
 
-    public void testConstructor5(){
+    /**
+     *
+     */
+    public void testConstructor5() {
         try {
-            Integer[] ints = new Integer[N];
-            for (int i = 0; i < N-1; ++i)
+            Integer[] ints = new Integer[SIZE];
+            for (int i = 0; i < SIZE-1; ++i)
                 ints[i] = new Integer(i);
             PriorityQueue q = new PriorityQueue(Arrays.asList(ints));
-            fail("Cannot make with null elements");
+            shouldThrow();
         }
         catch (NullPointerException success) {}
     }
 
-    public void testConstructor6(){
+    /**
+     *
+     */
+    public void testConstructor6() {
         try {
-            Integer[] ints = new Integer[N];
-            for (int i = 0; i < N; ++i)
+            Integer[] ints = new Integer[SIZE];
+            for (int i = 0; i < SIZE; ++i)
                 ints[i] = new Integer(i);
             PriorityQueue q = new PriorityQueue(Arrays.asList(ints));
-            for (int i = 0; i < N; ++i)
+            for (int i = 0; i < SIZE; ++i)
                 assertEquals(ints[i], q.poll());
         }
         finally {}
     }
 
-    public void testConstructor7(){
+    /**
+     *
+     */
+    public void testConstructor7() {
         try {
-            PriorityQueue q = new PriorityQueue(N, new MyReverseComparator());
-            Integer[] ints = new Integer[N];
-            for (int i = 0; i < N; ++i)
+            MyReverseComparator cmp = new MyReverseComparator();
+            PriorityQueue q = new PriorityQueue(SIZE, cmp);
+            assertEquals(cmp, q.comparator());
+            Integer[] ints = new Integer[SIZE];
+            for (int i = 0; i < SIZE; ++i)
                 ints[i] = new Integer(i);
             q.addAll(Arrays.asList(ints));
-            for (int i = N-1; i >= 0; --i)
+            for (int i = SIZE-1; i >= 0; --i)
                 assertEquals(ints[i], q.poll());
         }
         finally {}
     }
 
+    /**
+     *
+     */
     public void testEmpty() {
         PriorityQueue q = new PriorityQueue(2);
         assertTrue(q.isEmpty());
@@ -128,106 +150,139 @@ public class PriorityQueueTest extends T
         assertTrue(q.isEmpty());
     }
 
+    /**
+     *
+     */
     public void testSize() {
-        PriorityQueue q = fullQueue(N);
-        for (int i = 0; i < N; ++i) {
-            assertEquals(N-i, q.size());
+        PriorityQueue q = populatedQueue(SIZE);
+        for (int i = 0; i < SIZE; ++i) {
+            assertEquals(SIZE-i, q.size());
             q.remove();
         }
-        for (int i = 0; i < N; ++i) {
+        for (int i = 0; i < SIZE; ++i) {
             assertEquals(i, q.size());
             q.add(new Integer(i));
         }
     }
 
-    public void testOfferNull(){
+    /**
+     *
+     */
+    public void testOfferNull() {
 	try {
             PriorityQueue q = new PriorityQueue(1);
             q.offer(null);
-            fail("should throw NPE");
+            shouldThrow();
         } catch (NullPointerException success) { }   
     }
 
+    /**
+     *
+     */
     public void testOffer() {
         PriorityQueue q = new PriorityQueue(1);
         assertTrue(q.offer(new Integer(0)));
         assertTrue(q.offer(new Integer(1)));
     }
 
+    /**
+     *
+     */
     public void testOfferNonComparable() {
         try {
             PriorityQueue q = new PriorityQueue(1);
             q.offer(new Object());
             q.offer(new Object());
             q.offer(new Object());
-            fail("should throw CCE");
+            shouldThrow();
         }
         catch(ClassCastException success) {}
     }
 
-    public void testAdd(){
-        PriorityQueue q = new PriorityQueue(N);
-        for (int i = 0; i < N; ++i) {
+    /**
+     *
+     */
+    public void testAdd() {
+        PriorityQueue q = new PriorityQueue(SIZE);
+        for (int i = 0; i < SIZE; ++i) {
             assertEquals(i, q.size());
             assertTrue(q.add(new Integer(i)));
         }
     }
 
-    public void testAddAll1(){
+    /**
+     *
+     */
+    public void testAddAll1() {
         try {
             PriorityQueue q = new PriorityQueue(1);
             q.addAll(null);
-            fail("Cannot add null collection");
+            shouldThrow();
         }
         catch (NullPointerException success) {}
     }
-    public void testAddAll2(){
+    /**
+     *
+     */
+    public void testAddAll2() {
         try {
-            PriorityQueue q = new PriorityQueue(N);
-            Integer[] ints = new Integer[N];
+            PriorityQueue q = new PriorityQueue(SIZE);
+            Integer[] ints = new Integer[SIZE];
             q.addAll(Arrays.asList(ints));
-            fail("Cannot add null elements");
+            shouldThrow();
         }
         catch (NullPointerException success) {}
     }
-    public void testAddAll3(){
+    /**
+     *
+     */
+    public void testAddAll3() {
         try {
-            PriorityQueue q = new PriorityQueue(N);
-            Integer[] ints = new Integer[N];
-            for (int i = 0; i < N-1; ++i)
+            PriorityQueue q = new PriorityQueue(SIZE);
+            Integer[] ints = new Integer[SIZE];
+            for (int i = 0; i < SIZE-1; ++i)
                 ints[i] = new Integer(i);
             q.addAll(Arrays.asList(ints));
-            fail("Cannot add null elements");
+            shouldThrow();
         }
         catch (NullPointerException success) {}
     }
 
-    public void testAddAll5(){
+    /**
+     *
+     */
+    public void testAddAll5() {
         try {
             Integer[] empty = new Integer[0];
-            Integer[] ints = new Integer[N];
-            for (int i = 0; i < N; ++i)
-                ints[i] = new Integer(N-1-i);
-            PriorityQueue q = new PriorityQueue(N);
+            Integer[] ints = new Integer[SIZE];
+            for (int i = 0; i < SIZE; ++i)
+                ints[i] = new Integer(SIZE-1-i);
+            PriorityQueue q = new PriorityQueue(SIZE);
             assertFalse(q.addAll(Arrays.asList(empty)));
             assertTrue(q.addAll(Arrays.asList(ints)));
-            for (int i = 0; i < N; ++i)
+            for (int i = 0; i < SIZE; ++i)
                 assertEquals(new Integer(i), q.poll());
         }
         finally {}
     }
 
-    public void testPoll(){
-        PriorityQueue q = fullQueue(N);
-        for (int i = 0; i < N; ++i) {
+    /**
+     *
+     */
+    public void testPoll() {
+        PriorityQueue q = populatedQueue(SIZE);
+        for (int i = 0; i < SIZE; ++i) {
             assertEquals(i, ((Integer)q.poll()).intValue());
         }
 	assertNull(q.poll());
     }
 
-    public void testPeek(){
-        PriorityQueue q = fullQueue(N);
-        for (int i = 0; i < N; ++i) {
+    /**
+     *
+     */
+    public void testPeek() {
+        PriorityQueue q = populatedQueue(SIZE);
+        for (int i = 0; i < SIZE; ++i) {
             assertEquals(i, ((Integer)q.peek()).intValue());
             q.poll();
             assertTrue(q.peek() == null ||
@@ -236,54 +291,69 @@ public class PriorityQueueTest extends T
 	assertNull(q.peek());
     }
 
-    public void testElement(){
-        PriorityQueue q = fullQueue(N);
-        for (int i = 0; i < N; ++i) {
+    /**
+     *
+     */
+    public void testElement() {
+        PriorityQueue q = populatedQueue(SIZE);
+        for (int i = 0; i < SIZE; ++i) {
             assertEquals(i, ((Integer)q.element()).intValue());
             q.poll();
         }
         try {
             q.element();
-            fail("no such element");
+            shouldThrow();
         }
         catch (NoSuchElementException success) {}
     }
 
-    public void testRemove(){
-        PriorityQueue q = fullQueue(N);
-        for (int i = 0; i < N; ++i) {
+    /**
+     *
+     */
+    public void testRemove() {
+        PriorityQueue q = populatedQueue(SIZE);
+        for (int i = 0; i < SIZE; ++i) {
             assertEquals(i, ((Integer)q.remove()).intValue());
         }
         try {
             q.remove();
-            fail("remove should throw");
+            shouldThrow();
         } catch (NoSuchElementException success){
 	}   
     }
 
-    public void testRemoveElement(){
-        PriorityQueue q = fullQueue(N);
-        for (int i = 1; i < N; i+=2) {
+    /**
+     *
+     */
+    public void testRemoveElement() {
+        PriorityQueue q = populatedQueue(SIZE);
+        for (int i = 1; i < SIZE; i+=2) {
             assertTrue(q.remove(new Integer(i)));
         }
-        for (int i = 0; i < N; i+=2) {
+        for (int i = 0; i < SIZE; i+=2) {
             assertTrue(q.remove(new Integer(i)));
             assertFalse(q.remove(new Integer(i+1)));
         }
-        assert(q.isEmpty());
+        assertTrue(q.isEmpty());
     }
 	
-    public void testContains(){
-        PriorityQueue q = fullQueue(N);
-        for (int i = 0; i < N; ++i) {
+    /**
+     *
+     */
+    public void testContains() {
+        PriorityQueue q = populatedQueue(SIZE);
+        for (int i = 0; i < SIZE; ++i) {
             assertTrue(q.contains(new Integer(i)));
             q.poll();
             assertFalse(q.contains(new Integer(i)));
         }
     }
 
-    public void testClear(){
-        PriorityQueue q = fullQueue(N);
+    /**
+     *
+     */
+    public void testClear() {
+        PriorityQueue q = populatedQueue(SIZE);
         q.clear();
         assertTrue(q.isEmpty());
         assertEquals(0, q.size());
@@ -293,10 +363,13 @@ public class PriorityQueueTest extends T
         assertTrue(q.isEmpty());
     }
 
-    public void testContainsAll(){
-        PriorityQueue q = fullQueue(N);
-        PriorityQueue p = new PriorityQueue(N);
-        for (int i = 0; i < N; ++i) {
+    /**
+     *
+     */
+    public void testContainsAll() {
+        PriorityQueue q = populatedQueue(SIZE);
+        PriorityQueue p = new PriorityQueue(SIZE);
+        for (int i = 0; i < SIZE; ++i) {
             assertTrue(q.containsAll(p));
             assertFalse(p.containsAll(q));
             p.add(new Integer(i));
@@ -304,10 +377,13 @@ public class PriorityQueueTest extends T
         assertTrue(p.containsAll(q));
     }
 
-    public void testRetainAll(){
-        PriorityQueue q = fullQueue(N);
-        PriorityQueue p = fullQueue(N);
-        for (int i = 0; i < N; ++i) {
+    /**
+     *
+     */
+    public void testRetainAll() {
+        PriorityQueue q = populatedQueue(SIZE);
+        PriorityQueue p = populatedQueue(SIZE);
+        for (int i = 0; i < SIZE; ++i) {
             boolean changed = q.retainAll(p);
             if (i == 0)
                 assertFalse(changed);
@@ -315,17 +391,20 @@ public class PriorityQueueTest extends T
                 assertTrue(changed);
 
             assertTrue(q.containsAll(p));
-            assertEquals(N-i, q.size());
+            assertEquals(SIZE-i, q.size());
             p.remove();
         }
     }
 
-    public void testRemoveAll(){
-        for (int i = 1; i < N; ++i) {
-            PriorityQueue q = fullQueue(N);
-            PriorityQueue p = fullQueue(i);
+    /**
+     *
+     */
+    public void testRemoveAll() {
+        for (int i = 1; i < SIZE; ++i) {
+            PriorityQueue q = populatedQueue(SIZE);
+            PriorityQueue p = populatedQueue(i);
             assertTrue(q.removeAll(p));
-            assertEquals(N-i, q.size());
+            assertEquals(SIZE-i, q.size());
             for (int j = 0; j < i; ++j) {
                 Integer I = (Integer)(p.remove());
                 assertFalse(q.contains(I));
@@ -333,38 +412,48 @@ public class PriorityQueueTest extends T
         }
     }
 
-    public void testToArray(){
-        PriorityQueue q = fullQueue(N);
+    /**
+     *
+     */
+    public void testToArray() {
+        PriorityQueue q = populatedQueue(SIZE);
 	Object[] o = q.toArray();
         Arrays.sort(o);
 	for(int i = 0; i < o.length; i++)
 	    assertEquals(o[i], q.poll());
     }
 
-    public void testToArray2(){
-        PriorityQueue q = fullQueue(N);
-	Integer[] ints = new Integer[N];
+    /**
+     *
+     */
+    public void testToArray2() {
+        PriorityQueue q = populatedQueue(SIZE);
+	Integer[] ints = new Integer[SIZE];
 	ints = (Integer[])q.toArray(ints);
         Arrays.sort(ints);
         for(int i = 0; i < ints.length; i++)
             assertEquals(ints[i], q.poll());
     }
     
-    public void testIterator(){
-        PriorityQueue q = fullQueue(N);
+    /**
+     *
+     */
+    public void testIterator() {
+        PriorityQueue q = populatedQueue(SIZE);
         int i = 0;
 	Iterator it = q.iterator();
         while(it.hasNext()) {
             assertTrue(q.contains(it.next()));
             ++i;
         }
-        assertEquals(i, N);
+        assertEquals(i, SIZE);
     }
 
+    /**
+     *
+     */
     public void testIteratorRemove () {
-
         final PriorityQueue q = new PriorityQueue(3);
-
         q.add(new Integer(2));
         q.add(new Integer(1));
         q.add(new Integer(3));
@@ -380,12 +469,36 @@ public class PriorityQueueTest extends T
     }
 
 
-    public void testToString(){
-        PriorityQueue q = fullQueue(N);
+    /**
+     *
+     */
+    public void testToString() {
+        PriorityQueue q = populatedQueue(SIZE);
         String s = q.toString();
-        for (int i = 0; i < N; ++i) {
+        for (int i = 0; i < SIZE; ++i) {
             assertTrue(s.indexOf(String.valueOf(i)) >= 0);
         }
     }        
 
+    /**
+     *
+     */
+    public void testSerialization() {
+        PriorityQueue q = populatedQueue(SIZE);
+        try {
+            ByteArrayOutputStream bout = new ByteArrayOutputStream(10000);
+            ObjectOutputStream out = new ObjectOutputStream(new BufferedOutputStream(bout));
+            out.writeObject(q);
+            out.close();
+
+            ByteArrayInputStream bin = new ByteArrayInputStream(bout.toByteArray());
+            ObjectInputStream in = new ObjectInputStream(new BufferedInputStream(bin));
+            PriorityQueue r = (PriorityQueue)in.readObject();
+            assertEquals(q.size(), r.size());
+            while (!q.isEmpty()) 
+                assertEquals(q.remove(), r.remove());
+        } catch(Exception e){
+            unexpectedException();
+        }
+    }
 }