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

Comparing jsr166/src/test/tck/PriorityBlockingQueueTest.java (file contents):
Revision 1.3 by dl, Sun Sep 14 20:42:40 2003 UTC vs.
Revision 1.58 by jsr166, Sat Jan 17 22:55:06 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 static java.util.concurrent.TimeUnit.MILLISECONDS;
10 >
11 > import java.util.ArrayList;
12 > import java.util.Arrays;
13 > import java.util.Collection;
14 > import java.util.Comparator;
15 > import java.util.Iterator;
16 > import java.util.NoSuchElementException;
17 > import java.util.Queue;
18 > import java.util.concurrent.BlockingQueue;
19 > import java.util.concurrent.CountDownLatch;
20 > import java.util.concurrent.Executors;
21 > import java.util.concurrent.ExecutorService;
22 > import java.util.concurrent.PriorityBlockingQueue;
23 >
24 > import junit.framework.Test;
25  
26   public class PriorityBlockingQueueTest extends JSR166TestCase {
27 +
28 +    public static class Generic extends BlockingQueueTest {
29 +        protected BlockingQueue emptyCollection() {
30 +            return new PriorityBlockingQueue();
31 +        }
32 +    }
33 +
34 +    public static class InitialCapacity extends BlockingQueueTest {
35 +        protected BlockingQueue emptyCollection() {
36 +            return new PriorityBlockingQueue(SIZE);
37 +        }
38 +    }
39 +
40      public static void main(String[] args) {
41 <        junit.textui.TestRunner.run (suite());  
41 >        junit.textui.TestRunner.run(suite());
42      }
43  
44      public static Test suite() {
45 <        return new TestSuite(PriorityBlockingQueueTest.class);
45 >        return newTestSuite(PriorityBlockingQueueTest.class,
46 >                            new Generic().testSuite(),
47 >                            new InitialCapacity().testSuite());
48      }
49  
50      private static final int NOCAP = Integer.MAX_VALUE;
51  
52      /** Sample Comparator */
53 <    static class MyReverseComparator implements Comparator {
53 >    static class MyReverseComparator implements Comparator {
54          public int compare(Object x, Object y) {
55 <            int i = ((Integer)x).intValue();
28 <            int j = ((Integer)y).intValue();
29 <            if (i < j) return 1;
30 <            if (i > j) return -1;
31 <            return 0;
55 >            return ((Comparable)y).compareTo(x);
56          }
57      }
58  
35
59      /**
60 <     * Create a queue of given size containing consecutive
60 >     * Returns a new queue of given size containing consecutive
61       * Integers 0 ... n.
62       */
63 <    private PriorityBlockingQueue populatedQueue(int n) {
64 <        PriorityBlockingQueue q = new PriorityBlockingQueue(n);
63 >    private PriorityBlockingQueue<Integer> populatedQueue(int n) {
64 >        PriorityBlockingQueue<Integer> q =
65 >            new PriorityBlockingQueue<Integer>(n);
66          assertTrue(q.isEmpty());
67 <        for(int i = n-1; i >= 0; i-=2)
68 <            assertTrue(q.offer(new Integer(i)));
69 <        for(int i = (n & 1); i < n; i+=2)
70 <            assertTrue(q.offer(new Integer(i)));
67 >        for (int i = n-1; i >= 0; i -= 2)
68 >            assertTrue(q.offer(new Integer(i)));
69 >        for (int i = (n & 1); i < n; i += 2)
70 >            assertTrue(q.offer(new Integer(i)));
71          assertFalse(q.isEmpty());
72          assertEquals(NOCAP, q.remainingCapacity());
73 <        assertEquals(n, q.size());
73 >        assertEquals(n, q.size());
74          return q;
75      }
76 <
77 <    public void testConstructor1(){
76 >
77 >    /**
78 >     * A new queue has unbounded capacity
79 >     */
80 >    public void testConstructor1() {
81          assertEquals(NOCAP, new PriorityBlockingQueue(SIZE).remainingCapacity());
82      }
83  
84 <    public void testConstructor2(){
84 >    /**
85 >     * Constructor throws IAE if capacity argument nonpositive
86 >     */
87 >    public void testConstructor2() {
88          try {
89 <            PriorityBlockingQueue q = new PriorityBlockingQueue(0);
90 <            fail("Cannot make zero-sized");
91 <        }
62 <        catch (IllegalArgumentException success) {}
89 >            new PriorityBlockingQueue(0);
90 >            shouldThrow();
91 >        } catch (IllegalArgumentException success) {}
92      }
93  
94 <    public void testConstructor3(){
95 <
94 >    /**
95 >     * Initializing from null Collection throws NPE
96 >     */
97 >    public void testConstructor3() {
98          try {
99 <            PriorityBlockingQueue q = new PriorityBlockingQueue(null);
100 <            fail("Cannot make from null collection");
101 <        }
71 <        catch (NullPointerException success) {}
99 >            new PriorityBlockingQueue(null);
100 >            shouldThrow();
101 >        } catch (NullPointerException success) {}
102      }
103  
104 <    public void testConstructor4(){
104 >    /**
105 >     * Initializing from Collection of null elements throws NPE
106 >     */
107 >    public void testConstructor4() {
108 >        Collection<Integer> elements = Arrays.asList(new Integer[SIZE]);
109          try {
110 <            Integer[] ints = new Integer[SIZE];
111 <            PriorityBlockingQueue q = new PriorityBlockingQueue(Arrays.asList(ints));
112 <            fail("Cannot make with null elements");
79 <        }
80 <        catch (NullPointerException success) {}
110 >            new PriorityBlockingQueue(elements);
111 >            shouldThrow();
112 >        } catch (NullPointerException success) {}
113      }
114  
115 <    public void testConstructor5(){
116 <        try {
117 <            Integer[] ints = new Integer[SIZE];
118 <            for (int i = 0; i < SIZE-1; ++i)
119 <                ints[i] = new Integer(i);
120 <            PriorityBlockingQueue q = new PriorityBlockingQueue(Arrays.asList(ints));
121 <            fail("Cannot make with null elements");
122 <        }
123 <        catch (NullPointerException success) {}
115 >    /**
116 >     * Initializing from Collection with some null elements throws NPE
117 >     */
118 >    public void testConstructor5() {
119 >        Integer[] ints = new Integer[SIZE];
120 >        for (int i = 0; i < SIZE-1; ++i)
121 >            ints[i] = i;
122 >        Collection<Integer> elements = Arrays.asList(ints);
123 >        try {
124 >            new PriorityBlockingQueue(elements);
125 >            shouldThrow();
126 >        } catch (NullPointerException success) {}
127      }
128  
129 <    public void testConstructor6(){
130 <        try {
131 <            Integer[] ints = new Integer[SIZE];
132 <            for (int i = 0; i < SIZE; ++i)
133 <                ints[i] = new Integer(i);
134 <            PriorityBlockingQueue q = new PriorityBlockingQueue(Arrays.asList(ints));
135 <            for (int i = 0; i < SIZE; ++i)
136 <                assertEquals(ints[i], q.poll());
137 <        }
138 <        finally {}
129 >    /**
130 >     * Queue contains all elements of collection used to initialize
131 >     */
132 >    public void testConstructor6() {
133 >        Integer[] ints = new Integer[SIZE];
134 >        for (int i = 0; i < SIZE; ++i)
135 >            ints[i] = i;
136 >        PriorityBlockingQueue q = new PriorityBlockingQueue(Arrays.asList(ints));
137 >        for (int i = 0; i < SIZE; ++i)
138 >            assertEquals(ints[i], q.poll());
139      }
140  
141 <    public void testConstructor7(){
142 <        try {
143 <            PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE, new MyReverseComparator());
144 <            Integer[] ints = new Integer[SIZE];
145 <            for (int i = 0; i < SIZE; ++i)
146 <                ints[i] = new Integer(i);
147 <            q.addAll(Arrays.asList(ints));
148 <            for (int i = SIZE-1; i >= 0; --i)
149 <                assertEquals(ints[i], q.poll());
150 <        }
151 <        finally {}
141 >    /**
142 >     * The comparator used in constructor is used
143 >     */
144 >    public void testConstructor7() {
145 >        MyReverseComparator cmp = new MyReverseComparator();
146 >        PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE, cmp);
147 >        assertEquals(cmp, q.comparator());
148 >        Integer[] ints = new Integer[SIZE];
149 >        for (int i = 0; i < SIZE; ++i)
150 >            ints[i] = new Integer(i);
151 >        q.addAll(Arrays.asList(ints));
152 >        for (int i = SIZE-1; i >= 0; --i)
153 >            assertEquals(ints[i], q.poll());
154      }
155  
156 +    /**
157 +     * isEmpty is true before add, false after
158 +     */
159      public void testEmpty() {
160          PriorityBlockingQueue q = new PriorityBlockingQueue(2);
161          assertTrue(q.isEmpty());
162          assertEquals(NOCAP, q.remainingCapacity());
163 <        q.add(new Integer(1));
163 >        q.add(one);
164          assertFalse(q.isEmpty());
165 <        q.add(new Integer(2));
165 >        q.add(two);
166          q.remove();
167          q.remove();
168          assertTrue(q.isEmpty());
169      }
170  
171 <    public void testRemainingCapacity(){
171 >    /**
172 >     * remainingCapacity does not change when elements added or removed,
173 >     * but size does
174 >     */
175 >    public void testRemainingCapacity() {
176          PriorityBlockingQueue q = populatedQueue(SIZE);
177          for (int i = 0; i < SIZE; ++i) {
178              assertEquals(NOCAP, q.remainingCapacity());
# Line 142 | Line 186 | public class PriorityBlockingQueueTest e
186          }
187      }
188  
189 <    public void testOfferNull(){
190 <        try {
191 <            PriorityBlockingQueue q = new PriorityBlockingQueue(1);
148 <            q.offer(null);
149 <            fail("should throw NPE");
150 <        } catch (NullPointerException success) { }  
151 <    }
152 <
189 >    /**
190 >     * Offer of comparable element succeeds
191 >     */
192      public void testOffer() {
193          PriorityBlockingQueue q = new PriorityBlockingQueue(1);
194 <        assertTrue(q.offer(new Integer(0)));
195 <        assertTrue(q.offer(new Integer(1)));
194 >        assertTrue(q.offer(zero));
195 >        assertTrue(q.offer(one));
196      }
197  
198 +    /**
199 +     * Offer of non-Comparable throws CCE
200 +     */
201      public void testOfferNonComparable() {
202          try {
203              PriorityBlockingQueue q = new PriorityBlockingQueue(1);
204              q.offer(new Object());
205              q.offer(new Object());
206              q.offer(new Object());
207 <            fail("should throw CCE");
208 <        }
167 <        catch(ClassCastException success) {}
207 >            shouldThrow();
208 >        } catch (ClassCastException success) {}
209      }
210  
211 <    public void testAdd(){
211 >    /**
212 >     * add of comparable succeeds
213 >     */
214 >    public void testAdd() {
215          PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE);
216          for (int i = 0; i < SIZE; ++i) {
217              assertEquals(i, q.size());
# Line 175 | Line 219 | public class PriorityBlockingQueueTest e
219          }
220      }
221  
222 <    public void testAddAll1(){
223 <        try {
224 <            PriorityBlockingQueue q = new PriorityBlockingQueue(1);
225 <            q.addAll(null);
182 <            fail("Cannot add null collection");
183 <        }
184 <        catch (NullPointerException success) {}
185 <    }
186 <    public void testAddAll2(){
222 >    /**
223 >     * addAll(this) throws IAE
224 >     */
225 >    public void testAddAllSelf() {
226          try {
227 <            PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE);
228 <            Integer[] ints = new Integer[SIZE];
229 <            q.addAll(Arrays.asList(ints));
230 <            fail("Cannot add null elements");
192 <        }
193 <        catch (NullPointerException success) {}
227 >            PriorityBlockingQueue q = populatedQueue(SIZE);
228 >            q.addAll(q);
229 >            shouldThrow();
230 >        } catch (IllegalArgumentException success) {}
231      }
232 <    public void testAddAll3(){
232 >
233 >    /**
234 >     * addAll of a collection with any null elements throws NPE after
235 >     * possibly adding some elements
236 >     */
237 >    public void testAddAll3() {
238          try {
239              PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE);
240              Integer[] ints = new Integer[SIZE];
241              for (int i = 0; i < SIZE-1; ++i)
242                  ints[i] = new Integer(i);
243              q.addAll(Arrays.asList(ints));
244 <            fail("Cannot add null elements");
245 <        }
204 <        catch (NullPointerException success) {}
244 >            shouldThrow();
245 >        } catch (NullPointerException success) {}
246      }
247  
248 <    public void testAddAll5(){
249 <        try {
250 <            Integer[] empty = new Integer[0];
251 <            Integer[] ints = new Integer[SIZE];
252 <            for (int i = SIZE-1; i >= 0; --i)
253 <                ints[i] = new Integer(i);
254 <            PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE);
255 <            assertFalse(q.addAll(Arrays.asList(empty)));
256 <            assertTrue(q.addAll(Arrays.asList(ints)));
257 <            for (int i = 0; i < SIZE; ++i)
258 <                assertEquals(ints[i], q.poll());
259 <        }
260 <        finally {}
248 >    /**
249 >     * Queue contains all elements of successful addAll
250 >     */
251 >    public void testAddAll5() {
252 >        Integer[] empty = new Integer[0];
253 >        Integer[] ints = new Integer[SIZE];
254 >        for (int i = SIZE-1; i >= 0; --i)
255 >            ints[i] = new Integer(i);
256 >        PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE);
257 >        assertFalse(q.addAll(Arrays.asList(empty)));
258 >        assertTrue(q.addAll(Arrays.asList(ints)));
259 >        for (int i = 0; i < SIZE; ++i)
260 >            assertEquals(ints[i], q.poll());
261      }
262  
263 <     public void testPutNull() {
264 <        try {
265 <            PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE);
266 <            q.put(null);
267 <            fail("put should throw NPE");
268 <        }
269 <        catch (NullPointerException success){
270 <        }  
271 <     }
231 <
232 <     public void testPut() {
233 <         try {
234 <             PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE);
235 <             for (int i = 0; i < SIZE; ++i) {
236 <                 Integer I = new Integer(i);
237 <                 q.put(I);
238 <                 assertTrue(q.contains(I));
239 <             }
240 <             assertEquals(SIZE, q.size());
241 <         }
242 <         finally {
263 >    /**
264 >     * all elements successfully put are contained
265 >     */
266 >    public void testPut() {
267 >        PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE);
268 >        for (int i = 0; i < SIZE; ++i) {
269 >            Integer x = new Integer(i);
270 >            q.put(x);
271 >            assertTrue(q.contains(x));
272          }
273 +        assertEquals(SIZE, q.size());
274      }
275  
276 <    public void testPutWithTake() {
276 >    /**
277 >     * put doesn't block waiting for take
278 >     */
279 >    public void testPutWithTake() throws InterruptedException {
280          final PriorityBlockingQueue q = new PriorityBlockingQueue(2);
281 <        Thread t = new Thread(new Runnable() {
282 <                public void run(){
283 <                    int added = 0;
284 <                    try {
285 <                        q.put(new Integer(0));
286 <                        ++added;
287 <                        q.put(new Integer(0));
288 <                        ++added;
289 <                        q.put(new Integer(0));
290 <                        ++added;
258 <                        q.put(new Integer(0));
259 <                        ++added;
260 <                        threadAssertTrue(added == 4);
261 <                    } finally {
262 <                    }
263 <                }
264 <            });
265 <        try {
266 <            t.start();
267 <            Thread.sleep(SHORT_DELAY_MS);
268 <            q.take();
269 <            t.interrupt();
270 <            t.join();
271 <        } catch (Exception e){
272 <            fail("Unexpected exception");
273 <        }
281 >        final int size = 4;
282 >        Thread t = newStartedThread(new CheckedRunnable() {
283 >            public void realRun() {
284 >                for (int i = 0; i < size; i++)
285 >                    q.put(new Integer(0));
286 >            }});
287 >
288 >        awaitTermination(t);
289 >        assertEquals(size, q.size());
290 >        q.take();
291      }
292  
293 <    public void testTimedOffer() {
293 >    /**
294 >     * timed offer does not time out
295 >     */
296 >    public void testTimedOffer() throws InterruptedException {
297          final PriorityBlockingQueue q = new PriorityBlockingQueue(2);
298 <        Thread t = new Thread(new Runnable() {
299 <                public void run(){
300 <                    try {
301 <                        q.put(new Integer(0));
302 <                        q.put(new Integer(0));
303 <                        threadAssertTrue(q.offer(new Integer(0), SHORT_DELAY_MS, TimeUnit.MILLISECONDS));
304 <                        threadAssertTrue(q.offer(new Integer(0), LONG_DELAY_MS, TimeUnit.MILLISECONDS));
285 <                    } finally { }
286 <                }
287 <            });
288 <        
289 <        try {
290 <            t.start();
291 <            Thread.sleep(SMALL_DELAY_MS);
292 <            t.interrupt();
293 <            t.join();
294 <        } catch (Exception e){
295 <            fail("Unexpected exception");
296 <        }
297 <    }
298 >        Thread t = newStartedThread(new CheckedRunnable() {
299 >            public void realRun() {
300 >                q.put(new Integer(0));
301 >                q.put(new Integer(0));
302 >                assertTrue(q.offer(new Integer(0), SHORT_DELAY_MS, MILLISECONDS));
303 >                assertTrue(q.offer(new Integer(0), LONG_DELAY_MS, MILLISECONDS));
304 >            }});
305  
306 <    public void testTake(){
300 <        try {
301 <            PriorityBlockingQueue q = populatedQueue(SIZE);
302 <            for (int i = 0; i < SIZE; ++i) {
303 <                assertEquals(i, ((Integer)q.take()).intValue());
304 <            }
305 <        } catch (InterruptedException e){
306 <            fail("Unexpected exception");
307 <        }  
306 >        awaitTermination(t);
307      }
308  
309 <    public void testTakeFromEmpty() {
310 <        final PriorityBlockingQueue q = new PriorityBlockingQueue(2);
311 <        Thread t = new Thread(new Runnable() {
312 <                public void run(){
313 <                    try {
314 <                        q.take();
315 <                        threadFail("Should block");
317 <                    } catch (InterruptedException success){ }                
318 <                }
319 <            });
320 <        try {
321 <            t.start();
322 <            Thread.sleep(SHORT_DELAY_MS);
323 <            t.interrupt();
324 <            t.join();
325 <        } catch (Exception e){
326 <            fail("Unexpected exception");
309 >    /**
310 >     * take retrieves elements in priority order
311 >     */
312 >    public void testTake() throws InterruptedException {
313 >        PriorityBlockingQueue q = populatedQueue(SIZE);
314 >        for (int i = 0; i < SIZE; ++i) {
315 >            assertEquals(i, q.take());
316          }
317      }
318  
319 <    public void testBlockingTake(){
320 <        Thread t = new Thread(new Runnable() {
321 <                public void run() {
322 <                    try {
323 <                        PriorityBlockingQueue q = populatedQueue(SIZE);
324 <                        for (int i = 0; i < SIZE; ++i) {
325 <                            threadAssertEquals(i, ((Integer)q.take()).intValue());
326 <                        }
327 <                        q.take();
328 <                        threadFail("take should block");
329 <                    } catch (InterruptedException success){
341 <                    }  
342 <                }});
343 <        t.start();
344 <        try {
345 <           Thread.sleep(SHORT_DELAY_MS);
346 <           t.interrupt();
347 <           t.join();
348 <        }
349 <        catch (InterruptedException ie) {
350 <            fail("Unexpected exception");
351 <        }
352 <    }
319 >    /**
320 >     * Take removes existing elements until empty, then blocks interruptibly
321 >     */
322 >    public void testBlockingTake() throws InterruptedException {
323 >        final PriorityBlockingQueue q = populatedQueue(SIZE);
324 >        final CountDownLatch pleaseInterrupt = new CountDownLatch(1);
325 >        Thread t = newStartedThread(new CheckedRunnable() {
326 >            public void realRun() throws InterruptedException {
327 >                for (int i = 0; i < SIZE; ++i) {
328 >                    assertEquals(i, q.take());
329 >                }
330  
331 +                Thread.currentThread().interrupt();
332 +                try {
333 +                    q.take();
334 +                    shouldThrow();
335 +                } catch (InterruptedException success) {}
336 +                assertFalse(Thread.interrupted());
337 +
338 +                pleaseInterrupt.countDown();
339 +                try {
340 +                    q.take();
341 +                    shouldThrow();
342 +                } catch (InterruptedException success) {}
343 +                assertFalse(Thread.interrupted());
344 +            }});
345 +
346 +        await(pleaseInterrupt);
347 +        assertThreadStaysAlive(t);
348 +        t.interrupt();
349 +        awaitTermination(t);
350 +    }
351  
352 <    public void testPoll(){
352 >    /**
353 >     * poll succeeds unless empty
354 >     */
355 >    public void testPoll() {
356          PriorityBlockingQueue q = populatedQueue(SIZE);
357          for (int i = 0; i < SIZE; ++i) {
358 <            assertEquals(i, ((Integer)q.poll()).intValue());
358 >            assertEquals(i, q.poll());
359          }
360 <        assertNull(q.poll());
360 >        assertNull(q.poll());
361      }
362  
363 <    public void testTimedPoll0() {
364 <        try {
365 <            PriorityBlockingQueue q = populatedQueue(SIZE);
366 <            for (int i = 0; i < SIZE; ++i) {
367 <                assertEquals(i, ((Integer)q.poll(0, TimeUnit.MILLISECONDS)).intValue());
368 <            }
369 <            assertNull(q.poll(0, TimeUnit.MILLISECONDS));
370 <        } catch (InterruptedException e){
371 <            fail("Unexpected exception");
372 <        }  
363 >    /**
364 >     * timed poll with zero timeout succeeds when non-empty, else times out
365 >     */
366 >    public void testTimedPoll0() throws InterruptedException {
367 >        PriorityBlockingQueue q = populatedQueue(SIZE);
368 >        for (int i = 0; i < SIZE; ++i) {
369 >            assertEquals(i, q.poll(0, MILLISECONDS));
370 >        }
371 >        assertNull(q.poll(0, MILLISECONDS));
372      }
373  
374 <    public void testTimedPoll() {
375 <        try {
376 <            PriorityBlockingQueue q = populatedQueue(SIZE);
377 <            for (int i = 0; i < SIZE; ++i) {
378 <                assertEquals(i, ((Integer)q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS)).intValue());
379 <            }
380 <            assertNull(q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS));
381 <        } catch (InterruptedException e){
382 <            fail("Unexpected exception");
383 <        }  
384 <    }
385 <
386 <    public void testInterruptedTimedPoll(){
387 <        Thread t = new Thread(new Runnable() {
389 <                public void run() {
390 <                    try {
391 <                        PriorityBlockingQueue q = populatedQueue(SIZE);
392 <                        for (int i = 0; i < SIZE; ++i) {
393 <                            threadAssertEquals(i, ((Integer)q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS)).intValue());
394 <                        }
395 <                        threadAssertNull(q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS));
396 <                    } catch (InterruptedException success){
397 <                    }  
398 <                }});
399 <        t.start();
400 <        try {
401 <           Thread.sleep(SHORT_DELAY_MS);
402 <           t.interrupt();
403 <           t.join();
404 <        }
405 <        catch (InterruptedException ie) {
406 <            fail("Unexpected exception");
407 <        }
374 >    /**
375 >     * timed poll with nonzero timeout succeeds when non-empty, else times out
376 >     */
377 >    public void testTimedPoll() throws InterruptedException {
378 >        PriorityBlockingQueue<Integer> q = populatedQueue(SIZE);
379 >        for (int i = 0; i < SIZE; ++i) {
380 >            long startTime = System.nanoTime();
381 >            assertEquals(i, (int) q.poll(LONG_DELAY_MS, MILLISECONDS));
382 >            assertTrue(millisElapsedSince(startTime) < LONG_DELAY_MS);
383 >        }
384 >        long startTime = System.nanoTime();
385 >        assertNull(q.poll(timeoutMillis(), MILLISECONDS));
386 >        assertTrue(millisElapsedSince(startTime) >= timeoutMillis());
387 >        checkEmpty(q);
388      }
389  
390 <    public void testTimedPollWithOffer(){
391 <        final PriorityBlockingQueue q = new PriorityBlockingQueue(2);
392 <        Thread t = new Thread(new Runnable() {
393 <                public void run(){
394 <                    try {
395 <                        threadAssertNull(q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS));
396 <                        q.poll(LONG_DELAY_MS, TimeUnit.MILLISECONDS);
397 <                        q.poll(LONG_DELAY_MS, TimeUnit.MILLISECONDS);
398 <                        threadFail("Should block");
399 <                    } catch (InterruptedException success) { }                
390 >    /**
391 >     * Interrupted timed poll throws InterruptedException instead of
392 >     * returning timeout status
393 >     */
394 >    public void testInterruptedTimedPoll() throws InterruptedException {
395 >        final BlockingQueue<Integer> q = populatedQueue(SIZE);
396 >        final CountDownLatch aboutToWait = new CountDownLatch(1);
397 >        Thread t = newStartedThread(new CheckedRunnable() {
398 >            public void realRun() throws InterruptedException {
399 >                for (int i = 0; i < SIZE; ++i) {
400 >                    long t0 = System.nanoTime();
401 >                    assertEquals(i, (int) q.poll(LONG_DELAY_MS, MILLISECONDS));
402 >                    assertTrue(millisElapsedSince(t0) < SMALL_DELAY_MS);
403                  }
404 <            });
405 <        try {
406 <            t.start();
407 <            Thread.sleep(SMALL_DELAY_MS);
408 <            assertTrue(q.offer(new Integer(0), SHORT_DELAY_MS, TimeUnit.MILLISECONDS));
409 <            t.interrupt();
410 <            t.join();
411 <        } catch (Exception e){
412 <            fail("Unexpected exception");
430 <        }
431 <    }  
404 >                long t0 = System.nanoTime();
405 >                aboutToWait.countDown();
406 >                try {
407 >                    q.poll(LONG_DELAY_MS, MILLISECONDS);
408 >                    shouldThrow();
409 >                } catch (InterruptedException success) {
410 >                    assertTrue(millisElapsedSince(t0) < MEDIUM_DELAY_MS);
411 >                }
412 >            }});
413  
414 +        aboutToWait.await();
415 +        waitForThreadToEnterWaitState(t, SMALL_DELAY_MS);
416 +        t.interrupt();
417 +        awaitTermination(t, MEDIUM_DELAY_MS);
418 +    }
419  
420 <    public void testPeek(){
420 >    /**
421 >     * peek returns next element, or null if empty
422 >     */
423 >    public void testPeek() {
424          PriorityBlockingQueue q = populatedQueue(SIZE);
425          for (int i = 0; i < SIZE; ++i) {
426 <            assertEquals(i, ((Integer)q.peek()).intValue());
427 <            q.poll();
426 >            assertEquals(i, q.peek());
427 >            assertEquals(i, q.poll());
428              assertTrue(q.peek() == null ||
429 <                       i != ((Integer)q.peek()).intValue());
429 >                       !q.peek().equals(i));
430          }
431 <        assertNull(q.peek());
431 >        assertNull(q.peek());
432      }
433  
434 <    public void testElement(){
434 >    /**
435 >     * element returns next element, or throws NSEE if empty
436 >     */
437 >    public void testElement() {
438          PriorityBlockingQueue q = populatedQueue(SIZE);
439          for (int i = 0; i < SIZE; ++i) {
440 <            assertEquals(i, ((Integer)q.element()).intValue());
441 <            q.poll();
440 >            assertEquals(i, q.element());
441 >            assertEquals(i, q.poll());
442          }
443          try {
444              q.element();
445 <            fail("no such element");
446 <        }
455 <        catch (NoSuchElementException success) {}
445 >            shouldThrow();
446 >        } catch (NoSuchElementException success) {}
447      }
448  
449 <    public void testRemove(){
449 >    /**
450 >     * remove removes next element, or throws NSEE if empty
451 >     */
452 >    public void testRemove() {
453          PriorityBlockingQueue q = populatedQueue(SIZE);
454          for (int i = 0; i < SIZE; ++i) {
455 <            assertEquals(i, ((Integer)q.remove()).intValue());
455 >            assertEquals(i, q.remove());
456          }
457          try {
458              q.remove();
459 <            fail("remove should throw");
460 <        } catch (NoSuchElementException success){
467 <        }  
459 >            shouldThrow();
460 >        } catch (NoSuchElementException success) {}
461      }
462  
463 <    public void testRemoveElement(){
464 <        PriorityBlockingQueue q = populatedQueue(SIZE);
465 <        for (int i = 1; i < SIZE; i+=2) {
466 <            assertTrue(q.remove(new Integer(i)));
474 <        }
475 <        for (int i = 0; i < SIZE; i+=2) {
476 <            assertTrue(q.remove(new Integer(i)));
477 <            assertFalse(q.remove(new Integer(i+1)));
478 <        }
479 <        assertTrue(q.isEmpty());
480 <    }
481 <        
482 <    public void testContains(){
463 >    /**
464 >     * contains(x) reports true when elements added but not yet removed
465 >     */
466 >    public void testContains() {
467          PriorityBlockingQueue q = populatedQueue(SIZE);
468          for (int i = 0; i < SIZE; ++i) {
469              assertTrue(q.contains(new Integer(i)));
# Line 488 | Line 472 | public class PriorityBlockingQueueTest e
472          }
473      }
474  
475 <    public void testClear(){
475 >    /**
476 >     * clear removes all elements
477 >     */
478 >    public void testClear() {
479          PriorityBlockingQueue q = populatedQueue(SIZE);
480          q.clear();
481          assertTrue(q.isEmpty());
482          assertEquals(0, q.size());
483 <        assertEquals(NOCAP, q.remainingCapacity());
497 <        q.add(new Integer(1));
483 >        q.add(one);
484          assertFalse(q.isEmpty());
485 +        assertTrue(q.contains(one));
486          q.clear();
487          assertTrue(q.isEmpty());
488      }
489  
490 <    public void testContainsAll(){
490 >    /**
491 >     * containsAll(c) is true when c contains a subset of elements
492 >     */
493 >    public void testContainsAll() {
494          PriorityBlockingQueue q = populatedQueue(SIZE);
495          PriorityBlockingQueue p = new PriorityBlockingQueue(SIZE);
496          for (int i = 0; i < SIZE; ++i) {
# Line 511 | Line 501 | public class PriorityBlockingQueueTest e
501          assertTrue(p.containsAll(q));
502      }
503  
504 <    public void testRetainAll(){
504 >    /**
505 >     * retainAll(c) retains only those elements of c and reports true if changed
506 >     */
507 >    public void testRetainAll() {
508          PriorityBlockingQueue q = populatedQueue(SIZE);
509          PriorityBlockingQueue p = populatedQueue(SIZE);
510          for (int i = 0; i < SIZE; ++i) {
# Line 527 | Line 520 | public class PriorityBlockingQueueTest e
520          }
521      }
522  
523 <    public void testRemoveAll(){
523 >    /**
524 >     * removeAll(c) removes only those elements of c and reports true if changed
525 >     */
526 >    public void testRemoveAll() {
527          for (int i = 1; i < SIZE; ++i) {
528              PriorityBlockingQueue q = populatedQueue(SIZE);
529              PriorityBlockingQueue p = populatedQueue(i);
530              assertTrue(q.removeAll(p));
531              assertEquals(SIZE-i, q.size());
532              for (int j = 0; j < i; ++j) {
533 <                Integer I = (Integer)(p.remove());
534 <                assertFalse(q.contains(I));
533 >                Integer x = (Integer)(p.remove());
534 >                assertFalse(q.contains(x));
535              }
536          }
537      }
538  
539 <    public void testToArray(){
539 >    /**
540 >     * toArray contains all elements
541 >     */
542 >    public void testToArray() throws InterruptedException {
543          PriorityBlockingQueue q = populatedQueue(SIZE);
544 <        Object[] o = q.toArray();
544 >        Object[] o = q.toArray();
545          Arrays.sort(o);
546 <        try {
547 <        for(int i = 0; i < o.length; i++)
549 <            assertEquals(o[i], q.take());
550 <        } catch (InterruptedException e){
551 <            fail("Unexpected exception");
552 <        }    
546 >        for (int i = 0; i < o.length; i++)
547 >            assertSame(o[i], q.take());
548      }
549  
550 <    public void testToArray2(){
551 <        PriorityBlockingQueue q = populatedQueue(SIZE);
552 <        Integer[] ints = new Integer[SIZE];
553 <        ints = (Integer[])q.toArray(ints);
550 >    /**
551 >     * toArray(a) contains all elements
552 >     */
553 >    public void testToArray2() throws InterruptedException {
554 >        PriorityBlockingQueue<Integer> q = populatedQueue(SIZE);
555 >        Integer[] ints = new Integer[SIZE];
556 >        Integer[] array = q.toArray(ints);
557 >        assertSame(ints, array);
558          Arrays.sort(ints);
559 <        try {
560 <            for(int i = 0; i < ints.length; i++)
561 <                assertEquals(ints[i], q.take());
562 <        } catch (InterruptedException e){
563 <            fail("Unexpected exception");
564 <        }    
565 <    }
566 <    
567 <    public void testIterator(){
568 <        PriorityBlockingQueue q = populatedQueue(SIZE);
569 <        int i = 0;
570 <        Iterator it = q.iterator();
571 <        while(it.hasNext()) {
559 >        for (int i = 0; i < ints.length; i++)
560 >            assertSame(ints[i], q.take());
561 >    }
562 >
563 >    /**
564 >     * toArray(incompatible array type) throws ArrayStoreException
565 >     */
566 >    public void testToArray1_BadArg() {
567 >        PriorityBlockingQueue q = populatedQueue(SIZE);
568 >        try {
569 >            q.toArray(new String[10]);
570 >            shouldThrow();
571 >        } catch (ArrayStoreException success) {}
572 >    }
573 >
574 >    /**
575 >     * iterator iterates through all elements
576 >     */
577 >    public void testIterator() {
578 >        PriorityBlockingQueue q = populatedQueue(SIZE);
579 >        Iterator it = q.iterator();
580 >        int i;
581 >        for (i = 0; it.hasNext(); i++)
582              assertTrue(q.contains(it.next()));
574            ++i;
575        }
583          assertEquals(i, SIZE);
584 +        assertIteratorExhausted(it);
585      }
586  
587 <    public void testIteratorRemove () {
587 >    /**
588 >     * iterator of empty collection has no elements
589 >     */
590 >    public void testEmptyIterator() {
591 >        assertIteratorExhausted(new PriorityBlockingQueue().iterator());
592 >    }
593  
594 +    /**
595 +     * iterator.remove removes current element
596 +     */
597 +    public void testIteratorRemove() {
598          final PriorityBlockingQueue q = new PriorityBlockingQueue(3);
582
599          q.add(new Integer(2));
600          q.add(new Integer(1));
601          q.add(new Integer(3));
# Line 594 | Line 610 | public class PriorityBlockingQueueTest e
610          assertFalse(it.hasNext());
611      }
612  
613 <
614 <    public void testToString(){
613 >    /**
614 >     * toString contains toStrings of elements
615 >     */
616 >    public void testToString() {
617          PriorityBlockingQueue q = populatedQueue(SIZE);
618          String s = q.toString();
619          for (int i = 0; i < SIZE; ++i) {
620 <            assertTrue(s.indexOf(String.valueOf(i)) >= 0);
620 >            assertTrue(s.contains(String.valueOf(i)));
621          }
622 <    }        
622 >    }
623  
624 +    /**
625 +     * timed poll transfers elements across Executor tasks
626 +     */
627      public void testPollInExecutor() {
607
628          final PriorityBlockingQueue q = new PriorityBlockingQueue(2);
629 <
629 >        final CheckedBarrier threadsStarted = new CheckedBarrier(2);
630          ExecutorService executor = Executors.newFixedThreadPool(2);
631 +        executor.execute(new CheckedRunnable() {
632 +            public void realRun() throws InterruptedException {
633 +                assertNull(q.poll());
634 +                threadsStarted.await();
635 +                assertSame(one, q.poll(LONG_DELAY_MS, MILLISECONDS));
636 +                checkEmpty(q);
637 +            }});
638 +
639 +        executor.execute(new CheckedRunnable() {
640 +            public void realRun() throws InterruptedException {
641 +                threadsStarted.await();
642 +                q.put(one);
643 +            }});
644  
612        executor.execute(new Runnable() {
613            public void run() {
614                threadAssertNull(q.poll());
615                try {
616                    threadAssertTrue(null != q.poll(MEDIUM_DELAY_MS, TimeUnit.MILLISECONDS));
617                    threadAssertTrue(q.isEmpty());
618                }
619                catch (InterruptedException e) {
620                    threadFail("should not be interrupted");
621                }
622            }
623        });
624
625        executor.execute(new Runnable() {
626            public void run() {
627                try {
628                    Thread.sleep(SMALL_DELAY_MS);
629                    q.put(new Integer(1));
630                }
631                catch (InterruptedException e) {
632                    threadFail("should not be interrupted");
633                }
634            }
635        });
636        
645          joinPool(executor);
646 +    }
647  
648 +    /**
649 +     * A deserialized serialized queue has same elements
650 +     */
651 +    public void testSerialization() throws Exception {
652 +        Queue x = populatedQueue(SIZE);
653 +        Queue y = serialClone(x);
654 +
655 +        assertNotSame(x, y);
656 +        assertEquals(x.size(), y.size());
657 +        while (!x.isEmpty()) {
658 +            assertFalse(y.isEmpty());
659 +            assertEquals(x.remove(), y.remove());
660 +        }
661 +        assertTrue(y.isEmpty());
662      }
663  
664 <    public void testSerialization() {
664 >    /**
665 >     * drainTo(c) empties queue into another collection c
666 >     */
667 >    public void testDrainTo() {
668          PriorityBlockingQueue q = populatedQueue(SIZE);
669 <        try {
670 <            ByteArrayOutputStream bout = new ByteArrayOutputStream(10000);
671 <            ObjectOutputStream out = new ObjectOutputStream(new BufferedOutputStream(bout));
672 <            out.writeObject(q);
673 <            out.close();
674 <
675 <            ByteArrayInputStream bin = new ByteArrayInputStream(bout.toByteArray());
676 <            ObjectInputStream in = new ObjectInputStream(new BufferedInputStream(bin));
677 <            PriorityBlockingQueue r = (PriorityBlockingQueue)in.readObject();
678 <            assertEquals(q.size(), r.size());
679 <            while (!q.isEmpty())
680 <                assertEquals(q.remove(), r.remove());
681 <        } catch(Exception e){
682 <            fail("unexpected exception");
669 >        ArrayList l = new ArrayList();
670 >        q.drainTo(l);
671 >        assertEquals(0, q.size());
672 >        assertEquals(SIZE, l.size());
673 >        for (int i = 0; i < SIZE; ++i)
674 >            assertEquals(l.get(i), new Integer(i));
675 >        q.add(zero);
676 >        q.add(one);
677 >        assertFalse(q.isEmpty());
678 >        assertTrue(q.contains(zero));
679 >        assertTrue(q.contains(one));
680 >        l.clear();
681 >        q.drainTo(l);
682 >        assertEquals(0, q.size());
683 >        assertEquals(2, l.size());
684 >        for (int i = 0; i < 2; ++i)
685 >            assertEquals(l.get(i), new Integer(i));
686 >    }
687 >
688 >    /**
689 >     * drainTo empties queue
690 >     */
691 >    public void testDrainToWithActivePut() throws InterruptedException {
692 >        final PriorityBlockingQueue q = populatedQueue(SIZE);
693 >        Thread t = new Thread(new CheckedRunnable() {
694 >            public void realRun() {
695 >                q.put(new Integer(SIZE+1));
696 >            }});
697 >
698 >        t.start();
699 >        ArrayList l = new ArrayList();
700 >        q.drainTo(l);
701 >        assertTrue(l.size() >= SIZE);
702 >        for (int i = 0; i < SIZE; ++i)
703 >            assertEquals(l.get(i), new Integer(i));
704 >        t.join();
705 >        assertTrue(q.size() + l.size() >= SIZE);
706 >    }
707 >
708 >    /**
709 >     * drainTo(c, n) empties first min(n, size) elements of queue into c
710 >     */
711 >    public void testDrainToN() {
712 >        PriorityBlockingQueue q = new PriorityBlockingQueue(SIZE*2);
713 >        for (int i = 0; i < SIZE + 2; ++i) {
714 >            for (int j = 0; j < SIZE; j++)
715 >                assertTrue(q.offer(new Integer(j)));
716 >            ArrayList l = new ArrayList();
717 >            q.drainTo(l, i);
718 >            int k = (i < SIZE) ? i : SIZE;
719 >            assertEquals(k, l.size());
720 >            assertEquals(SIZE-k, q.size());
721 >            for (int j = 0; j < k; ++j)
722 >                assertEquals(l.get(j), new Integer(j));
723 >            do {} while (q.poll() != null);
724 >        }
725 >    }
726 >
727 >    /**
728 >     * remove(null), contains(null) always return false
729 >     */
730 >    public void testNeverContainsNull() {
731 >        Collection<?>[] qs = {
732 >            new PriorityBlockingQueue<Object>(),
733 >            populatedQueue(2),
734 >        };
735 >
736 >        for (Collection<?> q : qs) {
737 >            assertFalse(q.contains(null));
738 >            assertFalse(q.remove(null));
739          }
740      }
741  

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines