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.62 by jsr166, Fri May 15 18:21:19 2015 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines