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

Comparing jsr166/src/test/tck/PriorityQueueTest.java (file contents):
Revision 1.3 by dl, Sun Sep 14 20:42:40 2003 UTC vs.
Revision 1.32 by jsr166, Sat Feb 28 20:13:46 2015 UTC

# Line 1 | Line 1
1   /*
2 < * Written by members of JCP JSR-166 Expert Group and released to the
3 < * public domain. Use, modify, and redistribute this code in any way
4 < * without acknowledgement. Other contributors include Andrew Wright,
5 < * Jeffrey Hayes, Pat Fischer, Mike Judd.
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/publicdomain/zero/1.0/
5 > * Other contributors include Andrew Wright, Jeffrey Hayes,
6 > * Pat Fisher, Mike Judd.
7   */
8  
9 < import junit.framework.*;
10 < import java.util.*;
11 < import java.util.concurrent.*;
12 < import java.io.*;
9 > import java.util.Arrays;
10 > import java.util.Collection;
11 > import java.util.Comparator;
12 > import java.util.Iterator;
13 > import java.util.NoSuchElementException;
14 > import java.util.PriorityQueue;
15 > import java.util.Queue;
16  
17 < public class PriorityQueueTest extends JSR166TestCase {
17 > import junit.framework.Test;
18 > import junit.framework.TestSuite;
19  
20 + public class PriorityQueueTest extends JSR166TestCase {
21      public static void main(String[] args) {
22 <        junit.textui.TestRunner.run (suite());  
22 >        junit.textui.TestRunner.run(suite());
23      }
18
24      public static Test suite() {
25 <        return new TestSuite(PriorityQueueTest.class);
25 >        return new TestSuite(PriorityQueueTest.class);
26      }
27  
28 <    static class MyReverseComparator implements Comparator {
28 >    static class MyReverseComparator implements Comparator {
29          public int compare(Object x, Object y) {
30 <            int i = ((Integer)x).intValue();
26 <            int j = ((Integer)y).intValue();
27 <            if (i < j) return 1;
28 <            if (i > j) return -1;
29 <            return 0;
30 >            return ((Comparable)y).compareTo(x);
31          }
32      }
33  
33
34      /**
35 <     * Create a queue of given size containing consecutive
35 >     * Returns a new queue of given size containing consecutive
36       * Integers 0 ... n.
37       */
38 <    private PriorityQueue populatedQueue(int n) {
39 <        PriorityQueue q = new PriorityQueue(n);
38 >    private PriorityQueue<Integer> populatedQueue(int n) {
39 >        PriorityQueue<Integer> q = new PriorityQueue<Integer>(n);
40          assertTrue(q.isEmpty());
41 <        for(int i = n-1; i >= 0; i-=2)
42 <            assertTrue(q.offer(new Integer(i)));
43 <        for(int i = (n & 1); i < n; i+=2)
44 <            assertTrue(q.offer(new Integer(i)));
41 >        for (int i = n-1; i >= 0; i -= 2)
42 >            assertTrue(q.offer(new Integer(i)));
43 >        for (int i = (n & 1); i < n; i += 2)
44 >            assertTrue(q.offer(new Integer(i)));
45          assertFalse(q.isEmpty());
46 <        assertEquals(n, q.size());
46 >        assertEquals(n, q.size());
47          return q;
48      }
49 <
50 <    public void testConstructor1(){
49 >
50 >    /**
51 >     * A new queue has unbounded capacity
52 >     */
53 >    public void testConstructor1() {
54          assertEquals(0, new PriorityQueue(SIZE).size());
55      }
56  
57 <    public void testConstructor2(){
57 >    /**
58 >     * Constructor throws IAE if capacity argument nonpositive
59 >     */
60 >    public void testConstructor2() {
61          try {
62 <            PriorityQueue q = new PriorityQueue(0);
63 <            fail("Cannot make zero-sized");
64 <        }
59 <        catch (IllegalArgumentException success) {}
62 >            new PriorityQueue(0);
63 >            shouldThrow();
64 >        } catch (IllegalArgumentException success) {}
65      }
66  
67 +    /**
68 +     * Initializing from null Collection throws NPE
69 +     */
70      public void testConstructor3() {
63
71          try {
72 <            PriorityQueue q = new PriorityQueue((Collection)null);
73 <            fail("Cannot make from null collection");
74 <        }
68 <        catch (NullPointerException success) {}
72 >            new PriorityQueue((Collection)null);
73 >            shouldThrow();
74 >        } catch (NullPointerException success) {}
75      }
76  
77 <    public void testConstructor4(){
77 >    /**
78 >     * Initializing from Collection of null elements throws NPE
79 >     */
80 >    public void testConstructor4() {
81          try {
82              Integer[] ints = new Integer[SIZE];
83 <            PriorityQueue q = new PriorityQueue(Arrays.asList(ints));
84 <            fail("Cannot make with null elements");
85 <        }
77 <        catch (NullPointerException success) {}
83 >            new PriorityQueue(Arrays.asList(ints));
84 >            shouldThrow();
85 >        } catch (NullPointerException success) {}
86      }
87  
88 <    public void testConstructor5(){
88 >    /**
89 >     * Initializing from Collection with some null elements throws NPE
90 >     */
91 >    public void testConstructor5() {
92          try {
93              Integer[] ints = new Integer[SIZE];
94              for (int i = 0; i < SIZE-1; ++i)
95                  ints[i] = new Integer(i);
96 <            PriorityQueue q = new PriorityQueue(Arrays.asList(ints));
97 <            fail("Cannot make with null elements");
98 <        }
88 <        catch (NullPointerException success) {}
96 >            new PriorityQueue(Arrays.asList(ints));
97 >            shouldThrow();
98 >        } catch (NullPointerException success) {}
99      }
100  
101 <    public void testConstructor6(){
102 <        try {
103 <            Integer[] ints = new Integer[SIZE];
104 <            for (int i = 0; i < SIZE; ++i)
105 <                ints[i] = new Integer(i);
106 <            PriorityQueue q = new PriorityQueue(Arrays.asList(ints));
107 <            for (int i = 0; i < SIZE; ++i)
108 <                assertEquals(ints[i], q.poll());
109 <        }
110 <        finally {}
101 >    /**
102 >     * Queue contains all elements of collection used to initialize
103 >     */
104 >    public void testConstructor6() {
105 >        Integer[] ints = new Integer[SIZE];
106 >        for (int i = 0; i < SIZE; ++i)
107 >            ints[i] = new Integer(i);
108 >        PriorityQueue q = new PriorityQueue(Arrays.asList(ints));
109 >        for (int i = 0; i < SIZE; ++i)
110 >            assertEquals(ints[i], q.poll());
111      }
112  
113 <    public void testConstructor7(){
114 <        try {
115 <            PriorityQueue q = new PriorityQueue(SIZE, new MyReverseComparator());
116 <            Integer[] ints = new Integer[SIZE];
117 <            for (int i = 0; i < SIZE; ++i)
118 <                ints[i] = new Integer(i);
119 <            q.addAll(Arrays.asList(ints));
120 <            for (int i = SIZE-1; i >= 0; --i)
121 <                assertEquals(ints[i], q.poll());
122 <        }
123 <        finally {}
113 >    /**
114 >     * The comparator used in constructor is used
115 >     */
116 >    public void testConstructor7() {
117 >        MyReverseComparator cmp = new MyReverseComparator();
118 >        PriorityQueue q = new PriorityQueue(SIZE, cmp);
119 >        assertEquals(cmp, q.comparator());
120 >        Integer[] ints = new Integer[SIZE];
121 >        for (int i = 0; i < SIZE; ++i)
122 >            ints[i] = new Integer(i);
123 >        q.addAll(Arrays.asList(ints));
124 >        for (int i = SIZE-1; i >= 0; --i)
125 >            assertEquals(ints[i], q.poll());
126      }
127  
128 +    /**
129 +     * isEmpty is true before add, false after
130 +     */
131      public void testEmpty() {
132          PriorityQueue q = new PriorityQueue(2);
133          assertTrue(q.isEmpty());
# Line 124 | Line 139 | public class PriorityQueueTest extends J
139          assertTrue(q.isEmpty());
140      }
141  
142 +    /**
143 +     * size changes when elements added and removed
144 +     */
145      public void testSize() {
146          PriorityQueue q = populatedQueue(SIZE);
147          for (int i = 0; i < SIZE; ++i) {
# Line 136 | Line 154 | public class PriorityQueueTest extends J
154          }
155      }
156  
157 <    public void testOfferNull(){
158 <        try {
157 >    /**
158 >     * offer(null) throws NPE
159 >     */
160 >    public void testOfferNull() {
161 >        try {
162              PriorityQueue q = new PriorityQueue(1);
163              q.offer(null);
164 <            fail("should throw NPE");
165 <        } catch (NullPointerException success) { }  
164 >            shouldThrow();
165 >        } catch (NullPointerException success) {}
166 >    }
167 >
168 >    /**
169 >     * add(null) throws NPE
170 >     */
171 >    public void testAddNull() {
172 >        try {
173 >            PriorityQueue q = new PriorityQueue(1);
174 >            q.add(null);
175 >            shouldThrow();
176 >        } catch (NullPointerException success) {}
177      }
178  
179 +    /**
180 +     * Offer of comparable element succeeds
181 +     */
182      public void testOffer() {
183          PriorityQueue q = new PriorityQueue(1);
184 <        assertTrue(q.offer(new Integer(0)));
185 <        assertTrue(q.offer(new Integer(1)));
184 >        assertTrue(q.offer(zero));
185 >        assertTrue(q.offer(one));
186      }
187  
188 +    /**
189 +     * Offer of non-Comparable throws CCE
190 +     */
191      public void testOfferNonComparable() {
192 +        PriorityQueue q = new PriorityQueue(1);
193          try {
155            PriorityQueue q = new PriorityQueue(1);
194              q.offer(new Object());
195              q.offer(new Object());
196 <            q.offer(new Object());
197 <            fail("should throw CCE");
160 <        }
161 <        catch(ClassCastException success) {}
196 >            shouldThrow();
197 >        } catch (ClassCastException success) {}
198      }
199  
200 <    public void testAdd(){
200 >    /**
201 >     * add of comparable succeeds
202 >     */
203 >    public void testAdd() {
204          PriorityQueue q = new PriorityQueue(SIZE);
205          for (int i = 0; i < SIZE; ++i) {
206              assertEquals(i, q.size());
# Line 169 | Line 208 | public class PriorityQueueTest extends J
208          }
209      }
210  
211 <    public void testAddAll1(){
211 >    /**
212 >     * addAll(null) throws NPE
213 >     */
214 >    public void testAddAll1() {
215          try {
216              PriorityQueue q = new PriorityQueue(1);
217              q.addAll(null);
218 <            fail("Cannot add null collection");
219 <        }
178 <        catch (NullPointerException success) {}
218 >            shouldThrow();
219 >        } catch (NullPointerException success) {}
220      }
221 <    public void testAddAll2(){
221 >
222 >    /**
223 >     * addAll of a collection with null elements throws NPE
224 >     */
225 >    public void testAddAll2() {
226          try {
227              PriorityQueue q = new PriorityQueue(SIZE);
228              Integer[] ints = new Integer[SIZE];
229              q.addAll(Arrays.asList(ints));
230 <            fail("Cannot add null elements");
231 <        }
187 <        catch (NullPointerException success) {}
230 >            shouldThrow();
231 >        } catch (NullPointerException success) {}
232      }
233 <    public void testAddAll3(){
233 >
234 >    /**
235 >     * addAll of a collection with any null elements throws NPE after
236 >     * possibly adding some elements
237 >     */
238 >    public void testAddAll3() {
239          try {
240              PriorityQueue q = new PriorityQueue(SIZE);
241              Integer[] ints = new Integer[SIZE];
242              for (int i = 0; i < SIZE-1; ++i)
243                  ints[i] = new Integer(i);
244              q.addAll(Arrays.asList(ints));
245 <            fail("Cannot add null elements");
246 <        }
198 <        catch (NullPointerException success) {}
245 >            shouldThrow();
246 >        } catch (NullPointerException success) {}
247      }
248  
249 <    public void testAddAll5(){
250 <        try {
251 <            Integer[] empty = new Integer[0];
252 <            Integer[] ints = new Integer[SIZE];
253 <            for (int i = 0; i < SIZE; ++i)
254 <                ints[i] = new Integer(SIZE-1-i);
255 <            PriorityQueue q = new PriorityQueue(SIZE);
256 <            assertFalse(q.addAll(Arrays.asList(empty)));
257 <            assertTrue(q.addAll(Arrays.asList(ints)));
258 <            for (int i = 0; i < SIZE; ++i)
259 <                assertEquals(new Integer(i), q.poll());
260 <        }
261 <        finally {}
249 >    /**
250 >     * Queue contains all elements of successful addAll
251 >     */
252 >    public void testAddAll5() {
253 >        Integer[] empty = new Integer[0];
254 >        Integer[] ints = new Integer[SIZE];
255 >        for (int i = 0; i < SIZE; ++i)
256 >            ints[i] = new Integer(SIZE-1-i);
257 >        PriorityQueue q = new PriorityQueue(SIZE);
258 >        assertFalse(q.addAll(Arrays.asList(empty)));
259 >        assertTrue(q.addAll(Arrays.asList(ints)));
260 >        for (int i = 0; i < SIZE; ++i)
261 >            assertEquals(new Integer(i), q.poll());
262      }
263  
264 <    public void testPoll(){
264 >    /**
265 >     * poll succeeds unless empty
266 >     */
267 >    public void testPoll() {
268          PriorityQueue q = populatedQueue(SIZE);
269          for (int i = 0; i < SIZE; ++i) {
270 <            assertEquals(i, ((Integer)q.poll()).intValue());
270 >            assertEquals(i, q.poll());
271          }
272 <        assertNull(q.poll());
272 >        assertNull(q.poll());
273      }
274  
275 <    public void testPeek(){
275 >    /**
276 >     * peek returns next element, or null if empty
277 >     */
278 >    public void testPeek() {
279          PriorityQueue q = populatedQueue(SIZE);
280          for (int i = 0; i < SIZE; ++i) {
281 <            assertEquals(i, ((Integer)q.peek()).intValue());
282 <            q.poll();
281 >            assertEquals(i, q.peek());
282 >            assertEquals(i, q.poll());
283              assertTrue(q.peek() == null ||
284 <                       i != ((Integer)q.peek()).intValue());
284 >                       !q.peek().equals(i));
285          }
286 <        assertNull(q.peek());
286 >        assertNull(q.peek());
287      }
288  
289 <    public void testElement(){
289 >    /**
290 >     * element returns next element, or throws NSEE if empty
291 >     */
292 >    public void testElement() {
293          PriorityQueue q = populatedQueue(SIZE);
294          for (int i = 0; i < SIZE; ++i) {
295 <            assertEquals(i, ((Integer)q.element()).intValue());
296 <            q.poll();
295 >            assertEquals(i, q.element());
296 >            assertEquals(i, q.poll());
297          }
298          try {
299              q.element();
300 <            fail("no such element");
301 <        }
245 <        catch (NoSuchElementException success) {}
300 >            shouldThrow();
301 >        } catch (NoSuchElementException success) {}
302      }
303  
304 <    public void testRemove(){
304 >    /**
305 >     * remove removes next element, or throws NSEE if empty
306 >     */
307 >    public void testRemove() {
308          PriorityQueue q = populatedQueue(SIZE);
309          for (int i = 0; i < SIZE; ++i) {
310 <            assertEquals(i, ((Integer)q.remove()).intValue());
310 >            assertEquals(i, q.remove());
311          }
312          try {
313              q.remove();
314 <            fail("remove should throw");
315 <        } catch (NoSuchElementException success){
257 <        }  
314 >            shouldThrow();
315 >        } catch (NoSuchElementException success) {}
316      }
317  
318 <    public void testRemoveElement(){
318 >    /**
319 >     * remove(x) removes x and returns true if present
320 >     */
321 >    public void testRemoveElement() {
322          PriorityQueue q = populatedQueue(SIZE);
323 <        for (int i = 1; i < SIZE; i+=2) {
324 <            assertTrue(q.remove(new Integer(i)));
325 <        }
326 <        for (int i = 0; i < SIZE; i+=2) {
327 <            assertTrue(q.remove(new Integer(i)));
328 <            assertFalse(q.remove(new Integer(i+1)));
323 >        for (int i = 1; i < SIZE; i += 2) {
324 >            assertTrue(q.contains(i));
325 >            assertTrue(q.remove(i));
326 >            assertFalse(q.contains(i));
327 >            assertTrue(q.contains(i-1));
328 >        }
329 >        for (int i = 0; i < SIZE; i += 2) {
330 >            assertTrue(q.contains(i));
331 >            assertTrue(q.remove(i));
332 >            assertFalse(q.contains(i));
333 >            assertFalse(q.remove(i+1));
334 >            assertFalse(q.contains(i+1));
335          }
336          assertTrue(q.isEmpty());
337      }
338 <        
339 <    public void testContains(){
338 >
339 >    /**
340 >     * contains(x) reports true when elements added but not yet removed
341 >     */
342 >    public void testContains() {
343          PriorityQueue q = populatedQueue(SIZE);
344          for (int i = 0; i < SIZE; ++i) {
345              assertTrue(q.contains(new Integer(i)));
# Line 278 | Line 348 | public class PriorityQueueTest extends J
348          }
349      }
350  
351 <    public void testClear(){
351 >    /**
352 >     * clear removes all elements
353 >     */
354 >    public void testClear() {
355          PriorityQueue q = populatedQueue(SIZE);
356          q.clear();
357          assertTrue(q.isEmpty());
# Line 289 | Line 362 | public class PriorityQueueTest extends J
362          assertTrue(q.isEmpty());
363      }
364  
365 <    public void testContainsAll(){
365 >    /**
366 >     * containsAll(c) is true when c contains a subset of elements
367 >     */
368 >    public void testContainsAll() {
369          PriorityQueue q = populatedQueue(SIZE);
370          PriorityQueue p = new PriorityQueue(SIZE);
371          for (int i = 0; i < SIZE; ++i) {
# Line 300 | Line 376 | public class PriorityQueueTest extends J
376          assertTrue(p.containsAll(q));
377      }
378  
379 <    public void testRetainAll(){
379 >    /**
380 >     * retainAll(c) retains only those elements of c and reports true if changed
381 >     */
382 >    public void testRetainAll() {
383          PriorityQueue q = populatedQueue(SIZE);
384          PriorityQueue p = populatedQueue(SIZE);
385          for (int i = 0; i < SIZE; ++i) {
# Line 316 | Line 395 | public class PriorityQueueTest extends J
395          }
396      }
397  
398 <    public void testRemoveAll(){
398 >    /**
399 >     * removeAll(c) removes only those elements of c and reports true if changed
400 >     */
401 >    public void testRemoveAll() {
402          for (int i = 1; i < SIZE; ++i) {
403              PriorityQueue q = populatedQueue(SIZE);
404              PriorityQueue p = populatedQueue(i);
405              assertTrue(q.removeAll(p));
406              assertEquals(SIZE-i, q.size());
407              for (int j = 0; j < i; ++j) {
408 <                Integer I = (Integer)(p.remove());
409 <                assertFalse(q.contains(I));
408 >                Integer x = (Integer)(p.remove());
409 >                assertFalse(q.contains(x));
410              }
411          }
412      }
413  
414 <    public void testToArray(){
414 >    /**
415 >     * toArray contains all elements
416 >     */
417 >    public void testToArray() {
418          PriorityQueue q = populatedQueue(SIZE);
419 <        Object[] o = q.toArray();
419 >        Object[] o = q.toArray();
420          Arrays.sort(o);
421 <        for(int i = 0; i < o.length; i++)
422 <            assertEquals(o[i], q.poll());
421 >        for (int i = 0; i < o.length; i++)
422 >            assertSame(o[i], q.poll());
423      }
424  
425 <    public void testToArray2(){
426 <        PriorityQueue q = populatedQueue(SIZE);
427 <        Integer[] ints = new Integer[SIZE];
428 <        ints = (Integer[])q.toArray(ints);
425 >    /**
426 >     * toArray(a) contains all elements
427 >     */
428 >    public void testToArray2() {
429 >        PriorityQueue<Integer> q = populatedQueue(SIZE);
430 >        Integer[] ints = new Integer[SIZE];
431 >        Integer[] array = q.toArray(ints);
432 >        assertSame(ints, array);
433          Arrays.sort(ints);
434 <        for(int i = 0; i < ints.length; i++)
435 <            assertEquals(ints[i], q.poll());
434 >        for (int i = 0; i < ints.length; i++)
435 >            assertSame(ints[i], q.poll());
436      }
437 <    
438 <    public void testIterator(){
437 >
438 >    /**
439 >     * iterator iterates through all elements
440 >     */
441 >    public void testIterator() {
442          PriorityQueue q = populatedQueue(SIZE);
443 <        int i = 0;
444 <        Iterator it = q.iterator();
445 <        while(it.hasNext()) {
443 >        Iterator it = q.iterator();
444 >        int i;
445 >        for (i = 0; it.hasNext(); i++)
446              assertTrue(q.contains(it.next()));
355            ++i;
356        }
447          assertEquals(i, SIZE);
448 +        assertIteratorExhausted(it);
449      }
450  
451 <    public void testIteratorRemove () {
451 >    /**
452 >     * iterator of empty collection has no elements
453 >     */
454 >    public void testEmptyIterator() {
455 >        assertIteratorExhausted(new PriorityQueue().iterator());
456 >    }
457  
458 +    /**
459 +     * iterator.remove removes current element
460 +     */
461 +    public void testIteratorRemove() {
462          final PriorityQueue q = new PriorityQueue(3);
363
463          q.add(new Integer(2));
464          q.add(new Integer(1));
465          q.add(new Integer(3));
# Line 375 | Line 474 | public class PriorityQueueTest extends J
474          assertFalse(it.hasNext());
475      }
476  
477 <
478 <    public void testToString(){
477 >    /**
478 >     * toString contains toStrings of elements
479 >     */
480 >    public void testToString() {
481          PriorityQueue q = populatedQueue(SIZE);
482          String s = q.toString();
483          for (int i = 0; i < SIZE; ++i) {
484 <            assertTrue(s.indexOf(String.valueOf(i)) >= 0);
484 >            assertTrue(s.contains(String.valueOf(i)));
485          }
486 <    }        
486 >    }
487  
488 <    public void testSerialization() {
489 <        PriorityQueue q = populatedQueue(SIZE);
490 <        try {
491 <            ByteArrayOutputStream bout = new ByteArrayOutputStream(10000);
492 <            ObjectOutputStream out = new ObjectOutputStream(new BufferedOutputStream(bout));
493 <            out.writeObject(q);
494 <            out.close();
495 <
496 <            ByteArrayInputStream bin = new ByteArrayInputStream(bout.toByteArray());
497 <            ObjectInputStream in = new ObjectInputStream(new BufferedInputStream(bin));
498 <            PriorityQueue r = (PriorityQueue)in.readObject();
499 <            assertEquals(q.size(), r.size());
399 <            while (!q.isEmpty())
400 <                assertEquals(q.remove(), r.remove());
401 <        } catch(Exception e){
402 <            fail("unexpected exception");
488 >    /**
489 >     * A deserialized serialized queue has same elements
490 >     */
491 >    public void testSerialization() throws Exception {
492 >        Queue x = populatedQueue(SIZE);
493 >        Queue y = serialClone(x);
494 >
495 >        assertNotSame(x, y);
496 >        assertEquals(x.size(), y.size());
497 >        while (!x.isEmpty()) {
498 >            assertFalse(y.isEmpty());
499 >            assertEquals(x.remove(), y.remove());
500          }
501 +        assertTrue(y.isEmpty());
502      }
503   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines