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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines