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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines