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

Comparing jsr166/src/test/tck/ArrayBlockingQueueTest.java (file contents):
Revision 1.3 by dl, Sun Sep 14 20:42:40 2003 UTC vs.
Revision 1.40 by jsr166, Thu Nov 4 01:04:54 2010 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/licenses/publicdomain
5 > * Other contributors include Andrew Wright, Jeffrey Hayes,
6 > * Pat Fisher, Mike Judd.
7   */
8  
9 +
10   import junit.framework.*;
11   import java.util.*;
12   import java.util.concurrent.*;
13 + import static java.util.concurrent.TimeUnit.MILLISECONDS;
14   import java.io.*;
15  
16   public class ArrayBlockingQueueTest extends JSR166TestCase {
17  
18 +    public static class Fair extends BlockingQueueTest {
19 +        protected BlockingQueue emptyCollection() {
20 +            return new ArrayBlockingQueue(20, true);
21 +        }
22 +    }
23 +
24 +    public static class NonFair extends BlockingQueueTest {
25 +        protected BlockingQueue emptyCollection() {
26 +            return new ArrayBlockingQueue(20, false);
27 +        }
28 +    }
29 +
30      public static void main(String[] args) {
31 <        junit.textui.TestRunner.run (suite());  
31 >        junit.textui.TestRunner.run(suite());
32      }
33  
34      public static Test suite() {
35 <        return new TestSuite(ArrayBlockingQueueTest.class);
35 >        return newTestSuite(ArrayBlockingQueueTest.class,
36 >                            new Fair().testSuite(),
37 >                            new NonFair().testSuite());
38      }
39  
40      /**
# Line 27 | Line 44 | public class ArrayBlockingQueueTest exte
44      private ArrayBlockingQueue populatedQueue(int n) {
45          ArrayBlockingQueue q = new ArrayBlockingQueue(n);
46          assertTrue(q.isEmpty());
47 <        for(int i = 0; i < n; i++)
48 <            assertTrue(q.offer(new Integer(i)));
47 >        for (int i = 0; i < n; i++)
48 >            assertTrue(q.offer(new Integer(i)));
49          assertFalse(q.isEmpty());
50          assertEquals(0, q.remainingCapacity());
51 <        assertEquals(n, q.size());
51 >        assertEquals(n, q.size());
52          return q;
53      }
54 <
55 <    public void testConstructor1(){
54 >
55 >    /**
56 >     * A new queue has the indicated capacity
57 >     */
58 >    public void testConstructor1() {
59          assertEquals(SIZE, new ArrayBlockingQueue(SIZE).remainingCapacity());
60      }
61  
62 <    public void testConstructor2(){
62 >    /**
63 >     * Constructor throws IAE if capacity argument nonpositive
64 >     */
65 >    public void testConstructor2() {
66          try {
67              ArrayBlockingQueue q = new ArrayBlockingQueue(0);
68 <            fail("Cannot make zero-sized");
69 <        }
47 <        catch (IllegalArgumentException success) {}
68 >            shouldThrow();
69 >        } catch (IllegalArgumentException success) {}
70      }
71  
72 <    public void testConstructor3(){
73 <
72 >    /**
73 >     * Initializing from null Collection throws NPE
74 >     */
75 >    public void testConstructor3() {
76          try {
77              ArrayBlockingQueue q = new ArrayBlockingQueue(1, true, null);
78 <            fail("Cannot make from null collection");
79 <        }
56 <        catch (NullPointerException success) {}
78 >            shouldThrow();
79 >        } catch (NullPointerException success) {}
80      }
81  
82 <    public void testConstructor4(){
82 >    /**
83 >     * Initializing from Collection of null elements throws NPE
84 >     */
85 >    public void testConstructor4() {
86          try {
87              Integer[] ints = new Integer[SIZE];
88              ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE, false, Arrays.asList(ints));
89 <            fail("Cannot make with null elements");
90 <        }
65 <        catch (NullPointerException success) {}
89 >            shouldThrow();
90 >        } catch (NullPointerException success) {}
91      }
92  
93 <    public void testConstructor5(){
93 >    /**
94 >     * Initializing from Collection with some null elements throws NPE
95 >     */
96 >    public void testConstructor5() {
97          try {
98              Integer[] ints = new Integer[SIZE];
99              for (int i = 0; i < SIZE-1; ++i)
100                  ints[i] = new Integer(i);
101              ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE, false, Arrays.asList(ints));
102 <            fail("Cannot make with null elements");
103 <        }
76 <        catch (NullPointerException success) {}
102 >            shouldThrow();
103 >        } catch (NullPointerException success) {}
104      }
105  
106 <    public void testConstructor6(){
106 >    /**
107 >     * Initializing from too large collection throws IAE
108 >     */
109 >    public void testConstructor6() {
110          try {
111              Integer[] ints = new Integer[SIZE];
112              for (int i = 0; i < SIZE; ++i)
113                  ints[i] = new Integer(i);
114              ArrayBlockingQueue q = new ArrayBlockingQueue(1, false, Arrays.asList(ints));
115 <            fail("Cannot make with insufficient capacity");
116 <        }
87 <        catch (IllegalArgumentException success) {}
115 >            shouldThrow();
116 >        } catch (IllegalArgumentException success) {}
117      }
118  
119 <    public void testConstructor7(){
120 <        try {
121 <            Integer[] ints = new Integer[SIZE];
122 <            for (int i = 0; i < SIZE; ++i)
123 <                ints[i] = new Integer(i);
124 <            ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE, true, Arrays.asList(ints));
125 <            for (int i = 0; i < SIZE; ++i)
126 <                assertEquals(ints[i], q.poll());
127 <        }
128 <        finally {}
119 >    /**
120 >     * Queue contains all elements of collection used to initialize
121 >     */
122 >    public void testConstructor7() {
123 >        Integer[] ints = new Integer[SIZE];
124 >        for (int i = 0; i < SIZE; ++i)
125 >            ints[i] = new Integer(i);
126 >        ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE, true, Arrays.asList(ints));
127 >        for (int i = 0; i < SIZE; ++i)
128 >            assertEquals(ints[i], q.poll());
129      }
130  
131 +    /**
132 +     * Queue transitions from empty to full when elements added
133 +     */
134      public void testEmptyFull() {
135          ArrayBlockingQueue q = new ArrayBlockingQueue(2);
136          assertTrue(q.isEmpty());
137 <        assertEquals("should have room for 2", 2, q.remainingCapacity());
137 >        assertEquals(2, q.remainingCapacity());
138          q.add(one);
139          assertFalse(q.isEmpty());
140          q.add(two);
141          assertFalse(q.isEmpty());
142 <        assertEquals("queue should be full", 0, q.remainingCapacity());
143 <        assertFalse("offer should be rejected", q.offer(three));
142 >        assertEquals(0, q.remainingCapacity());
143 >        assertFalse(q.offer(three));
144      }
145  
146 <    public void testRemainingCapacity(){
146 >    /**
147 >     * remainingCapacity decreases on add, increases on remove
148 >     */
149 >    public void testRemainingCapacity() {
150          ArrayBlockingQueue q = populatedQueue(SIZE);
151          for (int i = 0; i < SIZE; ++i) {
152              assertEquals(i, q.remainingCapacity());
# Line 125 | Line 160 | public class ArrayBlockingQueueTest exte
160          }
161      }
162  
163 <    public void testOfferNull(){
164 <        try {
163 >    /**
164 >     * offer(null) throws NPE
165 >     */
166 >    public void testOfferNull() {
167 >        try {
168              ArrayBlockingQueue q = new ArrayBlockingQueue(1);
169              q.offer(null);
170 <            fail("should throw NPE");
171 <        } catch (NullPointerException success) { }  
170 >            shouldThrow();
171 >        } catch (NullPointerException success) {}
172      }
173  
174 <    public void testOffer(){
174 >    /**
175 >     * add(null) throws NPE
176 >     */
177 >    public void testAddNull() {
178 >        try {
179 >            ArrayBlockingQueue q = new ArrayBlockingQueue(1);
180 >            q.add(null);
181 >            shouldThrow();
182 >        } catch (NullPointerException success) {}
183 >    }
184 >
185 >    /**
186 >     * Offer succeeds if not full; fails if full
187 >     */
188 >    public void testOffer() {
189          ArrayBlockingQueue q = new ArrayBlockingQueue(1);
190          assertTrue(q.offer(zero));
191          assertFalse(q.offer(one));
192      }
193  
194 <    public void testAdd(){
195 <        try {
194 >    /**
195 >     * add succeeds if not full; throws ISE if full
196 >     */
197 >    public void testAdd() {
198 >        try {
199              ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE);
200              for (int i = 0; i < SIZE; ++i) {
201                  assertTrue(q.add(new Integer(i)));
202              }
203              assertEquals(0, q.remainingCapacity());
204              q.add(new Integer(SIZE));
205 <        } catch (IllegalStateException success){
206 <        }  
205 >            shouldThrow();
206 >        } catch (IllegalStateException success) {}
207      }
208  
209 <    public void testAddAll1(){
209 >    /**
210 >     * addAll(null) throws NPE
211 >     */
212 >    public void testAddAll1() {
213          try {
214              ArrayBlockingQueue q = new ArrayBlockingQueue(1);
215              q.addAll(null);
216 <            fail("Cannot add null collection");
217 <        }
160 <        catch (NullPointerException success) {}
216 >            shouldThrow();
217 >        } catch (NullPointerException success) {}
218      }
219 <    public void testAddAll2(){
219 >
220 >    /**
221 >     * addAll(this) throws IAE
222 >     */
223 >    public void testAddAllSelf() {
224 >        try {
225 >            ArrayBlockingQueue q = populatedQueue(SIZE);
226 >            q.addAll(q);
227 >            shouldThrow();
228 >        } catch (IllegalArgumentException success) {}
229 >    }
230 >
231 >
232 >    /**
233 >     * addAll of a collection with null elements throws NPE
234 >     */
235 >    public void testAddAll2() {
236          try {
237              ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE);
238              Integer[] ints = new Integer[SIZE];
239              q.addAll(Arrays.asList(ints));
240 <            fail("Cannot add null elements");
241 <        }
169 <        catch (NullPointerException success) {}
240 >            shouldThrow();
241 >        } catch (NullPointerException success) {}
242      }
243 <    public void testAddAll3(){
243 >
244 >    /**
245 >     * addAll of a collection with any null elements throws NPE after
246 >     * possibly adding some elements
247 >     */
248 >    public void testAddAll3() {
249          try {
250              ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE);
251              Integer[] ints = new Integer[SIZE];
252              for (int i = 0; i < SIZE-1; ++i)
253                  ints[i] = new Integer(i);
254              q.addAll(Arrays.asList(ints));
255 <            fail("Cannot add null elements");
256 <        }
180 <        catch (NullPointerException success) {}
255 >            shouldThrow();
256 >        } catch (NullPointerException success) {}
257      }
258 <    public void testAddAll4(){
258 >
259 >    /**
260 >     * addAll throws ISE if not enough room
261 >     */
262 >    public void testAddAll4() {
263          try {
264              ArrayBlockingQueue q = new ArrayBlockingQueue(1);
265              Integer[] ints = new Integer[SIZE];
266              for (int i = 0; i < SIZE; ++i)
267                  ints[i] = new Integer(i);
268              q.addAll(Arrays.asList(ints));
269 <            fail("Cannot add with insufficient capacity");
270 <        }
191 <        catch (IllegalStateException success) {}
269 >            shouldThrow();
270 >        } catch (IllegalStateException success) {}
271      }
272 <    public void testAddAll5(){
273 <        try {
274 <            Integer[] empty = new Integer[0];
275 <            Integer[] ints = new Integer[SIZE];
276 <            for (int i = 0; i < SIZE; ++i)
277 <                ints[i] = new Integer(i);
278 <            ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE);
279 <            assertFalse(q.addAll(Arrays.asList(empty)));
280 <            assertTrue(q.addAll(Arrays.asList(ints)));
281 <            for (int i = 0; i < SIZE; ++i)
282 <                assertEquals(ints[i], q.poll());
283 <        }
284 <        finally {}
272 >
273 >    /**
274 >     * Queue contains all elements, in traversal order, of successful addAll
275 >     */
276 >    public void testAddAll5() {
277 >        Integer[] empty = new Integer[0];
278 >        Integer[] ints = new Integer[SIZE];
279 >        for (int i = 0; i < SIZE; ++i)
280 >            ints[i] = new Integer(i);
281 >        ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE);
282 >        assertFalse(q.addAll(Arrays.asList(empty)));
283 >        assertTrue(q.addAll(Arrays.asList(ints)));
284 >        for (int i = 0; i < SIZE; ++i)
285 >            assertEquals(ints[i], q.poll());
286      }
287  
288 <     public void testPutNull() {
289 <        try {
288 >    /**
289 >     * put(null) throws NPE
290 >     */
291 >    public void testPutNull() throws InterruptedException {
292 >        try {
293              ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE);
294              q.put(null);
295 <            fail("put should throw NPE");
296 <        }
214 <        catch (NullPointerException success){
215 <        }  
216 <        catch (InterruptedException ie) {
217 <            fail("Unexpected exception");
218 <        }
295 >            shouldThrow();
296 >        } catch (NullPointerException success) {}
297       }
298  
299 <     public void testPut() {
300 <         try {
301 <             ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE);
302 <             for (int i = 0; i < SIZE; ++i) {
303 <                 Integer I = new Integer(i);
304 <                 q.put(I);
305 <                 assertTrue(q.contains(I));
306 <             }
307 <             assertEquals(0, q.remainingCapacity());
230 <         }
231 <        catch (InterruptedException ie) {
232 <            fail("Unexpected exception");
299 >    /**
300 >     * all elements successfully put are contained
301 >     */
302 >    public void testPut() throws InterruptedException {
303 >        ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE);
304 >        for (int i = 0; i < SIZE; ++i) {
305 >            Integer I = new Integer(i);
306 >            q.put(I);
307 >            assertTrue(q.contains(I));
308          }
309 +        assertEquals(0, q.remainingCapacity());
310      }
311  
312 <    public void testBlockingPut(){
313 <        Thread t = new Thread(new Runnable() {
314 <                public void run() {
315 <                    int added = 0;
316 <                    try {
317 <                        ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE);
318 <                        for (int i = 0; i < SIZE; ++i) {
319 <                            q.put(new Integer(i));
320 <                            ++added;
321 <                        }
322 <                        q.put(new Integer(SIZE));
323 <                        threadFail("put should block");
324 <                    } catch (InterruptedException ie){
325 <                        threadAssertEquals(added, SIZE);
326 <                    }  
327 <                }});
328 <        try {
329 <            t.start();
330 <           Thread.sleep(SHORT_DELAY_MS);
331 <           t.interrupt();
332 <           t.join();
333 <        }
334 <        catch (InterruptedException ie) {
259 <            fail("Unexpected exception");
260 <        }
312 >    /**
313 >     * put blocks interruptibly if full
314 >     */
315 >    public void testBlockingPut() throws InterruptedException {
316 >        final ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE);
317 >        Thread t = new Thread(new CheckedRunnable() {
318 >            public void realRun() throws InterruptedException {
319 >                for (int i = 0; i < SIZE; ++i)
320 >                    q.put(i);
321 >                assertEquals(SIZE, q.size());
322 >                assertEquals(0, q.remainingCapacity());
323 >                try {
324 >                    q.put(99);
325 >                    shouldThrow();
326 >                } catch (InterruptedException success) {}
327 >            }});
328 >
329 >        t.start();
330 >        Thread.sleep(SHORT_DELAY_MS);
331 >        t.interrupt();
332 >        t.join();
333 >        assertEquals(SIZE, q.size());
334 >        assertEquals(0, q.remainingCapacity());
335      }
336  
337 <    public void testPutWithTake() {
338 <        final ArrayBlockingQueue q = new ArrayBlockingQueue(2);
339 <        Thread t = new Thread(new Runnable() {
340 <                public void run(){
341 <                    int added = 0;
342 <                    try {
343 <                        q.put(new Object());
344 <                        ++added;
345 <                        q.put(new Object());
346 <                        ++added;
347 <                        q.put(new Object());
348 <                        ++added;
349 <                        q.put(new Object());
350 <                        ++added;
351 <                        threadFail("Should block");
352 <                    } catch (InterruptedException e){
353 <                        threadAssertTrue(added >= 2);
354 <                    }
355 <                }
356 <            });
357 <        try {
358 <            t.start();
359 <            Thread.sleep(SHORT_DELAY_MS);
360 <            q.take();
287 <            t.interrupt();
288 <            t.join();
289 <        } catch (Exception e){
290 <            fail("Unexpected exception");
291 <        }
337 >    /**
338 >     * put blocks waiting for take when full
339 >     */
340 >    public void testPutWithTake() throws InterruptedException {
341 >        final int capacity = 2;
342 >        final ArrayBlockingQueue q = new ArrayBlockingQueue(capacity);
343 >        Thread t = new Thread(new CheckedRunnable() {
344 >            public void realRun() throws InterruptedException {
345 >                for (int i = 0; i < capacity + 1; i++)
346 >                    q.put(i);
347 >                try {
348 >                    q.put(99);
349 >                    shouldThrow();
350 >                } catch (InterruptedException success) {}
351 >            }});
352 >
353 >        t.start();
354 >        Thread.sleep(SHORT_DELAY_MS);
355 >        assertEquals(q.remainingCapacity(), 0);
356 >        assertEquals(0, q.take());
357 >        Thread.sleep(SHORT_DELAY_MS);
358 >        t.interrupt();
359 >        t.join();
360 >        assertEquals(q.remainingCapacity(), 0);
361      }
362  
363 <    public void testTimedOffer() {
363 >    /**
364 >     * timed offer times out if full and elements not taken
365 >     */
366 >    public void testTimedOffer() throws InterruptedException {
367          final ArrayBlockingQueue q = new ArrayBlockingQueue(2);
368 <        Thread t = new Thread(new Runnable() {
369 <                public void run(){
370 <                    try {
371 <                        q.put(new Object());
372 <                        q.put(new Object());
373 <                        threadAssertFalse(q.offer(new Object(), SHORT_DELAY_MS/2, TimeUnit.MILLISECONDS));
374 <                        q.offer(new Object(), LONG_DELAY_MS, TimeUnit.MILLISECONDS);
375 <                        threadFail("Should block");
376 <                    } catch (InterruptedException success){}
377 <                }
378 <            });
379 <        
380 <        try {
381 <            t.start();
382 <            Thread.sleep(SHORT_DELAY_MS);
311 <            t.interrupt();
312 <            t.join();
313 <        } catch (Exception e){
314 <            fail("Unexpected exception");
315 <        }
316 <    }
317 <
318 <    public void testTake(){
319 <        try {
320 <            ArrayBlockingQueue q = populatedQueue(SIZE);
321 <            for (int i = 0; i < SIZE; ++i) {
322 <                assertEquals(i, ((Integer)q.take()).intValue());
323 <            }
324 <        } catch (InterruptedException e){
325 <            fail("Unexpected exception");
326 <        }  
368 >        Thread t = new Thread(new CheckedRunnable() {
369 >            public void realRun() throws InterruptedException {
370 >                q.put(new Object());
371 >                q.put(new Object());
372 >                assertFalse(q.offer(new Object(), SHORT_DELAY_MS/2, MILLISECONDS));
373 >                try {
374 >                    q.offer(new Object(), LONG_DELAY_MS, MILLISECONDS);
375 >                    shouldThrow();
376 >                } catch (InterruptedException success) {}
377 >            }});
378 >
379 >        t.start();
380 >        Thread.sleep(SHORT_DELAY_MS);
381 >        t.interrupt();
382 >        t.join();
383      }
384  
385 <    public void testTakeFromEmpty() {
386 <        final ArrayBlockingQueue q = new ArrayBlockingQueue(2);
387 <        Thread t = new Thread(new Runnable() {
388 <                public void run(){
389 <                    try {
390 <                        q.take();
391 <                        threadFail("Should block");
336 <                    } catch (InterruptedException success){ }                
337 <                }
338 <            });
339 <        try {
340 <            t.start();
341 <            Thread.sleep(SHORT_DELAY_MS);
342 <            t.interrupt();
343 <            t.join();
344 <        } catch (Exception e){
345 <            fail("Unexpected exception");
385 >    /**
386 >     * take retrieves elements in FIFO order
387 >     */
388 >    public void testTake() throws InterruptedException {
389 >        ArrayBlockingQueue q = populatedQueue(SIZE);
390 >        for (int i = 0; i < SIZE; ++i) {
391 >            assertEquals(i, q.take());
392          }
393      }
394  
395 <    public void testBlockingTake(){
396 <        Thread t = new Thread(new Runnable() {
397 <                public void run() {
398 <                    try {
399 <                        ArrayBlockingQueue q = populatedQueue(SIZE);
400 <                        for (int i = 0; i < SIZE; ++i) {
401 <                            threadAssertEquals(i, ((Integer)q.take()).intValue());
402 <                        }
403 <                        q.take();
404 <                        threadFail("take should block");
405 <                    } catch (InterruptedException success){
406 <                    }  
407 <                }});
408 <        try {
409 <            t.start();
410 <            Thread.sleep(SHORT_DELAY_MS);
411 <            t.interrupt();
412 <            t.join();
413 <        }
414 <        catch (InterruptedException ie) {
369 <            fail("Unexpected exception");
370 <        }
395 >    /**
396 >     * Take removes existing elements until empty, then blocks interruptibly
397 >     */
398 >    public void testBlockingTake() throws InterruptedException {
399 >        final ArrayBlockingQueue q = populatedQueue(SIZE);
400 >        Thread t = new Thread(new CheckedRunnable() {
401 >            public void realRun() throws InterruptedException {
402 >                for (int i = 0; i < SIZE; ++i) {
403 >                    assertEquals(i, q.take());
404 >                }
405 >                try {
406 >                    q.take();
407 >                    shouldThrow();
408 >                } catch (InterruptedException success) {}
409 >            }});
410 >
411 >        t.start();
412 >        Thread.sleep(SHORT_DELAY_MS);
413 >        t.interrupt();
414 >        t.join();
415      }
416  
417  
418 <    public void testPoll(){
418 >    /**
419 >     * poll succeeds unless empty
420 >     */
421 >    public void testPoll() {
422          ArrayBlockingQueue q = populatedQueue(SIZE);
423          for (int i = 0; i < SIZE; ++i) {
424 <            assertEquals(i, ((Integer)q.poll()).intValue());
424 >            assertEquals(i, q.poll());
425          }
426 <        assertNull(q.poll());
426 >        assertNull(q.poll());
427      }
428  
429 <    public void testTimedPoll0() {
430 <        try {
431 <            ArrayBlockingQueue q = populatedQueue(SIZE);
432 <            for (int i = 0; i < SIZE; ++i) {
433 <                assertEquals(i, ((Integer)q.poll(0, TimeUnit.MILLISECONDS)).intValue());
434 <            }
435 <            assertNull(q.poll(0, TimeUnit.MILLISECONDS));
436 <        } catch (InterruptedException e){
437 <            fail("Unexpected exception");
391 <        }  
429 >    /**
430 >     * timed poll with zero timeout succeeds when non-empty, else times out
431 >     */
432 >    public void testTimedPoll0() throws InterruptedException {
433 >        ArrayBlockingQueue q = populatedQueue(SIZE);
434 >        for (int i = 0; i < SIZE; ++i) {
435 >            assertEquals(i, q.poll(0, MILLISECONDS));
436 >        }
437 >        assertNull(q.poll(0, MILLISECONDS));
438      }
439  
440 <    public void testTimedPoll() {
441 <        try {
442 <            ArrayBlockingQueue q = populatedQueue(SIZE);
443 <            for (int i = 0; i < SIZE; ++i) {
444 <                assertEquals(i, ((Integer)q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS)).intValue());
445 <            }
446 <            assertNull(q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS));
401 <        } catch (InterruptedException e){
402 <            fail("Unexpected exception");
403 <        }  
404 <    }
405 <
406 <    public void testInterruptedTimedPoll(){
407 <        Thread t = new Thread(new Runnable() {
408 <                public void run() {
409 <                    try {
410 <                        ArrayBlockingQueue q = populatedQueue(SIZE);
411 <                        for (int i = 0; i < SIZE; ++i) {
412 <                            threadAssertEquals(i, ((Integer)q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS)).intValue());
413 <                        }
414 <                        threadAssertNull(q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS));
415 <                    } catch (InterruptedException success){
416 <                    }  
417 <                }});
418 <        try {
419 <            t.start();
420 <            Thread.sleep(SHORT_DELAY_MS);
421 <            t.interrupt();
422 <            t.join();
423 <        }
424 <        catch (InterruptedException ie) {
425 <            fail("Unexpected exception");
440 >    /**
441 >     * timed poll with nonzero timeout succeeds when non-empty, else times out
442 >     */
443 >    public void testTimedPoll() throws InterruptedException {
444 >        ArrayBlockingQueue q = populatedQueue(SIZE);
445 >        for (int i = 0; i < SIZE; ++i) {
446 >            assertEquals(i, q.poll(SHORT_DELAY_MS, MILLISECONDS));
447          }
448 +        assertNull(q.poll(SHORT_DELAY_MS, MILLISECONDS));
449      }
450  
451 <    public void testTimedPollWithOffer(){
452 <        final ArrayBlockingQueue q = new ArrayBlockingQueue(2);
453 <        Thread t = new Thread(new Runnable() {
454 <                public void run(){
455 <                    try {
456 <                        threadAssertNull(q.poll(SHORT_DELAY_MS, TimeUnit.MILLISECONDS));
457 <                        q.poll(LONG_DELAY_MS, TimeUnit.MILLISECONDS);
458 <                        q.poll(LONG_DELAY_MS, TimeUnit.MILLISECONDS);
459 <                        threadFail("Should block");
460 <                    } catch (InterruptedException success) { }                
451 >    /**
452 >     * Interrupted timed poll throws InterruptedException instead of
453 >     * returning timeout status
454 >     */
455 >    public void testInterruptedTimedPoll() throws InterruptedException {
456 >        Thread t = new Thread(new CheckedRunnable() {
457 >            public void realRun() throws InterruptedException {
458 >                ArrayBlockingQueue q = populatedQueue(SIZE);
459 >                for (int i = 0; i < SIZE; ++i) {
460 >                    assertEquals(i, q.poll(SHORT_DELAY_MS, MILLISECONDS));;
461                  }
462 <            });
463 <        try {
464 <            t.start();
465 <            Thread.sleep(SMALL_DELAY_MS);
466 <            assertTrue(q.offer(zero, SHORT_DELAY_MS, TimeUnit.MILLISECONDS));
467 <            t.interrupt();
468 <            t.join();
469 <        } catch (Exception e){
470 <            fail("Unexpected exception");
471 <        }
472 <    }  
451 <
462 >                try {
463 >                    q.poll(SMALL_DELAY_MS, MILLISECONDS);
464 >                    shouldThrow();
465 >                } catch (InterruptedException success) {}
466 >            }});
467 >
468 >        t.start();
469 >        Thread.sleep(SHORT_DELAY_MS);
470 >        t.interrupt();
471 >        t.join();
472 >    }
473  
474 <    public void testPeek(){
474 >    /**
475 >     * peek returns next element, or null if empty
476 >     */
477 >    public void testPeek() {
478          ArrayBlockingQueue q = populatedQueue(SIZE);
479          for (int i = 0; i < SIZE; ++i) {
480 <            assertEquals(i, ((Integer)q.peek()).intValue());
481 <            q.poll();
480 >            assertEquals(i, q.peek());
481 >            assertEquals(i, q.poll());
482              assertTrue(q.peek() == null ||
483 <                       i != ((Integer)q.peek()).intValue());
483 >                       !q.peek().equals(i));
484          }
485 <        assertNull(q.peek());
485 >        assertNull(q.peek());
486      }
487  
488 <    public void testElement(){
488 >    /**
489 >     * element returns next element, or throws NSEE if empty
490 >     */
491 >    public void testElement() {
492          ArrayBlockingQueue q = populatedQueue(SIZE);
493          for (int i = 0; i < SIZE; ++i) {
494 <            assertEquals(i, ((Integer)q.element()).intValue());
495 <            q.poll();
494 >            assertEquals(i, q.element());
495 >            assertEquals(i, q.poll());
496          }
497          try {
498              q.element();
499 <            fail("no such element");
500 <        }
474 <        catch (NoSuchElementException success) {}
499 >            shouldThrow();
500 >        } catch (NoSuchElementException success) {}
501      }
502  
503 <    public void testRemove(){
503 >    /**
504 >     * remove removes next element, or throws NSEE if empty
505 >     */
506 >    public void testRemove() {
507          ArrayBlockingQueue q = populatedQueue(SIZE);
508          for (int i = 0; i < SIZE; ++i) {
509 <            assertEquals(i, ((Integer)q.remove()).intValue());
509 >            assertEquals(i, q.remove());
510          }
511          try {
512              q.remove();
513 <            fail("remove should throw");
514 <        } catch (NoSuchElementException success){
486 <        }  
513 >            shouldThrow();
514 >        } catch (NoSuchElementException success) {}
515      }
516  
517 <    public void testRemoveElement(){
517 >    /**
518 >     * remove(x) removes x and returns true if present
519 >     */
520 >    public void testRemoveElement() {
521          ArrayBlockingQueue q = populatedQueue(SIZE);
522          for (int i = 1; i < SIZE; i+=2) {
523              assertTrue(q.remove(new Integer(i)));
# Line 497 | Line 528 | public class ArrayBlockingQueueTest exte
528          }
529          assertTrue(q.isEmpty());
530      }
531 <        
532 <    public void testContains(){
531 >
532 >    /**
533 >     * contains(x) reports true when elements added but not yet removed
534 >     */
535 >    public void testContains() {
536          ArrayBlockingQueue q = populatedQueue(SIZE);
537          for (int i = 0; i < SIZE; ++i) {
538              assertTrue(q.contains(new Integer(i)));
539 <            q.poll();
539 >            assertEquals(i, q.poll());
540              assertFalse(q.contains(new Integer(i)));
541          }
542      }
543  
544 <    public void testClear(){
544 >    /**
545 >     * clear removes all elements
546 >     */
547 >    public void testClear() {
548          ArrayBlockingQueue q = populatedQueue(SIZE);
549          q.clear();
550          assertTrue(q.isEmpty());
# Line 515 | Line 552 | public class ArrayBlockingQueueTest exte
552          assertEquals(SIZE, q.remainingCapacity());
553          q.add(one);
554          assertFalse(q.isEmpty());
555 +        assertTrue(q.contains(one));
556          q.clear();
557          assertTrue(q.isEmpty());
558      }
559  
560 <    public void testContainsAll(){
560 >    /**
561 >     * containsAll(c) is true when c contains a subset of elements
562 >     */
563 >    public void testContainsAll() {
564          ArrayBlockingQueue q = populatedQueue(SIZE);
565          ArrayBlockingQueue p = new ArrayBlockingQueue(SIZE);
566          for (int i = 0; i < SIZE; ++i) {
# Line 530 | Line 571 | public class ArrayBlockingQueueTest exte
571          assertTrue(p.containsAll(q));
572      }
573  
574 <    public void testRetainAll(){
574 >    /**
575 >     * retainAll(c) retains only those elements of c and reports true if changed
576 >     */
577 >    public void testRetainAll() {
578          ArrayBlockingQueue q = populatedQueue(SIZE);
579          ArrayBlockingQueue p = populatedQueue(SIZE);
580          for (int i = 0; i < SIZE; ++i) {
# Line 546 | Line 590 | public class ArrayBlockingQueueTest exte
590          }
591      }
592  
593 <    public void testRemoveAll(){
593 >    /**
594 >     * removeAll(c) removes only those elements of c and reports true if changed
595 >     */
596 >    public void testRemoveAll() {
597          for (int i = 1; i < SIZE; ++i) {
598              ArrayBlockingQueue q = populatedQueue(SIZE);
599              ArrayBlockingQueue p = populatedQueue(i);
# Line 559 | Line 606 | public class ArrayBlockingQueueTest exte
606          }
607      }
608  
609 +    /**
610 +     * toArray contains all elements in FIFO order
611 +     */
612 +    public void testToArray() {
613 +        ArrayBlockingQueue q = populatedQueue(SIZE);
614 +        Object[] o = q.toArray();
615 +        for (int i = 0; i < o.length; i++)
616 +            assertSame(o[i], q.poll());
617 +    }
618  
619 <    public void testToArray(){
619 >    /**
620 >     * toArray(a) contains all elements in FIFO order
621 >     */
622 >    public void testToArray2() {
623          ArrayBlockingQueue q = populatedQueue(SIZE);
624 <        Object[] o = q.toArray();
625 <        try {
626 <        for(int i = 0; i < o.length; i++)
627 <            assertEquals(o[i], q.take());
628 <        } catch (InterruptedException e){
629 <            fail("Unexpected exception");
630 <        }    
631 <    }
632 <
633 <    public void testToArray2(){
634 <        ArrayBlockingQueue q = populatedQueue(SIZE);
635 <        Integer[] ints = new Integer[SIZE];
636 <        ints = (Integer[])q.toArray(ints);
637 <        try {
638 <            for(int i = 0; i < ints.length; i++)
639 <                assertEquals(ints[i], q.take());
640 <        } catch (InterruptedException e){
641 <            fail("Unexpected exception");
642 <        }    
643 <    }
644 <    
645 <    public void testIterator(){
646 <        ArrayBlockingQueue q = populatedQueue(SIZE);
647 <        Iterator it = q.iterator();
648 <        try {
649 <            while(it.hasNext()){
591 <                assertEquals(it.next(), q.take());
592 <            }
593 <        } catch (InterruptedException e){
594 <            fail("Unexpected exception");
595 <        }    
624 >        Integer[] ints = new Integer[SIZE];
625 >        assertSame(ints, q.toArray(ints));
626 >        for (int i = 0; i < ints.length; i++)
627 >            assertSame(ints[i], q.poll());
628 >    }
629 >
630 >    /**
631 >     * toArray(null) throws NullPointerException
632 >     */
633 >    public void testToArray_NullArg() {
634 >        ArrayBlockingQueue q = populatedQueue(SIZE);
635 >        try {
636 >            q.toArray(null);
637 >            shouldThrow();
638 >        } catch (NullPointerException success) {}
639 >    }
640 >
641 >    /**
642 >     * toArray(incompatible array type) throws ArrayStoreException
643 >     */
644 >    public void testToArray1_BadArg() {
645 >        ArrayBlockingQueue q = populatedQueue(SIZE);
646 >        try {
647 >            q.toArray(new String[10]);
648 >            shouldThrow();
649 >        } catch (ArrayStoreException success) {}
650      }
651  
598    public void testIteratorOrdering() {
652  
653 +    /**
654 +     * iterator iterates through all elements
655 +     */
656 +    public void testIterator() throws InterruptedException {
657 +        ArrayBlockingQueue q = populatedQueue(SIZE);
658 +        Iterator it = q.iterator();
659 +        while (it.hasNext()) {
660 +            assertEquals(it.next(), q.take());
661 +        }
662 +    }
663 +
664 +    /**
665 +     * iterator.remove removes current element
666 +     */
667 +    public void testIteratorRemove() {
668          final ArrayBlockingQueue q = new ArrayBlockingQueue(3);
669 +        q.add(two);
670 +        q.add(one);
671 +        q.add(three);
672  
673 +        Iterator it = q.iterator();
674 +        it.next();
675 +        it.remove();
676 +
677 +        it = q.iterator();
678 +        assertSame(it.next(), one);
679 +        assertSame(it.next(), three);
680 +        assertFalse(it.hasNext());
681 +    }
682 +
683 +    /**
684 +     * iterator ordering is FIFO
685 +     */
686 +    public void testIteratorOrdering() {
687 +        final ArrayBlockingQueue q = new ArrayBlockingQueue(3);
688          q.add(one);
689          q.add(two);
690          q.add(three);
# Line 607 | Line 693 | public class ArrayBlockingQueueTest exte
693  
694          int k = 0;
695          for (Iterator it = q.iterator(); it.hasNext();) {
696 <            int i = ((Integer)(it.next())).intValue();
611 <            assertEquals("items should come out in order", ++k, i);
696 >            assertEquals(++k, it.next());
697          }
698 <
614 <        assertEquals("should go through 3 elements", 3, k);
698 >        assertEquals(3, k);
699      }
700  
701 <    public void testWeaklyConsistentIteration () {
702 <
701 >    /**
702 >     * Modifications do not cause iterators to fail
703 >     */
704 >    public void testWeaklyConsistentIteration() {
705          final ArrayBlockingQueue q = new ArrayBlockingQueue(3);
620
706          q.add(one);
707          q.add(two);
708          q.add(three);
709 <
710 <        try {
711 <            for (Iterator it = q.iterator(); it.hasNext();) {
627 <                q.remove();
628 <                it.next();
629 <            }
630 <        }
631 <        catch (ConcurrentModificationException e) {
632 <            fail("weakly consistent iterator; should not get CME");
709 >        for (Iterator it = q.iterator(); it.hasNext();) {
710 >            q.remove();
711 >            it.next();
712          }
713 <
635 <        assertEquals("queue should be empty again", 0, q.size());
713 >        assertEquals(0, q.size());
714      }
715  
716  
717 <    public void testToString(){
717 >    /**
718 >     * toString contains toStrings of elements
719 >     */
720 >    public void testToString() {
721          ArrayBlockingQueue q = populatedQueue(SIZE);
722          String s = q.toString();
723          for (int i = 0; i < SIZE; ++i) {
724              assertTrue(s.indexOf(String.valueOf(i)) >= 0);
725          }
726 <    }        
726 >    }
727  
728  
729 +    /**
730 +     * offer transfers elements across Executor tasks
731 +     */
732      public void testOfferInExecutor() {
649
733          final ArrayBlockingQueue q = new ArrayBlockingQueue(2);
651
734          q.add(one);
735          q.add(two);
654
736          ExecutorService executor = Executors.newFixedThreadPool(2);
737 +        executor.execute(new CheckedRunnable() {
738 +            public void realRun() throws InterruptedException {
739 +                assertFalse(q.offer(three));
740 +                assertTrue(q.offer(three, MEDIUM_DELAY_MS, MILLISECONDS));
741 +                assertEquals(0, q.remainingCapacity());
742 +            }});
743 +
744 +        executor.execute(new CheckedRunnable() {
745 +            public void realRun() throws InterruptedException {
746 +                Thread.sleep(SMALL_DELAY_MS);
747 +                assertSame(one, q.take());
748 +            }});
749  
657        executor.execute(new Runnable() {
658            public void run() {
659                threadAssertFalse(q.offer(three));
660                try {
661                    threadAssertTrue(q.offer(three, MEDIUM_DELAY_MS, TimeUnit.MILLISECONDS));
662                    threadAssertEquals(0, q.remainingCapacity());
663                }
664                catch (InterruptedException e) {
665                    threadFail("should not be interrupted");
666                }
667            }
668        });
669
670        executor.execute(new Runnable() {
671            public void run() {
672                try {
673                    Thread.sleep(SMALL_DELAY_MS);
674                    threadAssertEquals(one, q.take());
675                }
676                catch (InterruptedException e) {
677                    threadFail("should not be interrupted");
678                }
679            }
680        });
681        
750          joinPool(executor);
683
751      }
752  
753 +    /**
754 +     * poll retrieves elements across Executor threads
755 +     */
756      public void testPollInExecutor() {
687
757          final ArrayBlockingQueue q = new ArrayBlockingQueue(2);
689
758          ExecutorService executor = Executors.newFixedThreadPool(2);
759 +        executor.execute(new CheckedRunnable() {
760 +            public void realRun() throws InterruptedException {
761 +                assertNull(q.poll());
762 +                assertSame(one, q.poll(MEDIUM_DELAY_MS, MILLISECONDS));
763 +                assertTrue(q.isEmpty());
764 +            }});
765 +
766 +        executor.execute(new CheckedRunnable() {
767 +            public void realRun() throws InterruptedException {
768 +                Thread.sleep(SMALL_DELAY_MS);
769 +                q.put(one);
770 +            }});
771  
692        executor.execute(new Runnable() {
693            public void run() {
694                threadAssertNull(q.poll());
695                try {
696                    threadAssertTrue(null != q.poll(MEDIUM_DELAY_MS, TimeUnit.MILLISECONDS));
697                    threadAssertTrue(q.isEmpty());
698                }
699                catch (InterruptedException e) {
700                    threadFail("should not be interrupted");
701                }
702            }
703        });
704
705        executor.execute(new Runnable() {
706            public void run() {
707                try {
708                    Thread.sleep(SMALL_DELAY_MS);
709                    q.put(one);
710                }
711                catch (InterruptedException e) {
712                    threadFail("should not be interrupted");
713                }
714            }
715        });
716        
772          joinPool(executor);
773 +    }
774 +
775 +    /**
776 +     * A deserialized serialized queue has same elements in same order
777 +     */
778 +    public void testSerialization() throws Exception {
779 +        ArrayBlockingQueue q = populatedQueue(SIZE);
780  
781 +        ByteArrayOutputStream bout = new ByteArrayOutputStream(10000);
782 +        ObjectOutputStream out = new ObjectOutputStream(new BufferedOutputStream(bout));
783 +        out.writeObject(q);
784 +        out.close();
785 +
786 +        ByteArrayInputStream bin = new ByteArrayInputStream(bout.toByteArray());
787 +        ObjectInputStream in = new ObjectInputStream(new BufferedInputStream(bin));
788 +        ArrayBlockingQueue r = (ArrayBlockingQueue)in.readObject();
789 +        assertEquals(q.size(), r.size());
790 +        while (!q.isEmpty())
791 +            assertEquals(q.remove(), r.remove());
792      }
793  
794 <    public void testSerialization() {
794 >    /**
795 >     * drainTo(null) throws NPE
796 >     */
797 >    public void testDrainToNull() {
798          ArrayBlockingQueue q = populatedQueue(SIZE);
799 +        try {
800 +            q.drainTo(null);
801 +            shouldThrow();
802 +        } catch (NullPointerException success) {}
803 +    }
804  
805 +    /**
806 +     * drainTo(this) throws IAE
807 +     */
808 +    public void testDrainToSelf() {
809 +        ArrayBlockingQueue q = populatedQueue(SIZE);
810          try {
811 <            ByteArrayOutputStream bout = new ByteArrayOutputStream(10000);
812 <            ObjectOutputStream out = new ObjectOutputStream(new BufferedOutputStream(bout));
813 <            out.writeObject(q);
728 <            out.close();
729 <
730 <            ByteArrayInputStream bin = new ByteArrayInputStream(bout.toByteArray());
731 <            ObjectInputStream in = new ObjectInputStream(new BufferedInputStream(bin));
732 <            ArrayBlockingQueue r = (ArrayBlockingQueue)in.readObject();
733 <            assertEquals(q.size(), r.size());
734 <            while (!q.isEmpty())
735 <                assertEquals(q.remove(), r.remove());
736 <        } catch(Exception e){
737 <            fail("unexpected exception");
738 <        }
811 >            q.drainTo(q);
812 >            shouldThrow();
813 >        } catch (IllegalArgumentException success) {}
814      }
815  
816 +    /**
817 +     * drainTo(c) empties queue into another collection c
818 +     */
819 +    public void testDrainTo() {
820 +        ArrayBlockingQueue q = populatedQueue(SIZE);
821 +        ArrayList l = new ArrayList();
822 +        q.drainTo(l);
823 +        assertEquals(q.size(), 0);
824 +        assertEquals(l.size(), SIZE);
825 +        for (int i = 0; i < SIZE; ++i)
826 +            assertEquals(l.get(i), new Integer(i));
827 +        q.add(zero);
828 +        q.add(one);
829 +        assertFalse(q.isEmpty());
830 +        assertTrue(q.contains(zero));
831 +        assertTrue(q.contains(one));
832 +        l.clear();
833 +        q.drainTo(l);
834 +        assertEquals(q.size(), 0);
835 +        assertEquals(l.size(), 2);
836 +        for (int i = 0; i < 2; ++i)
837 +            assertEquals(l.get(i), new Integer(i));
838 +    }
839 +
840 +    /**
841 +     * drainTo empties full queue, unblocking a waiting put.
842 +     */
843 +    public void testDrainToWithActivePut() throws InterruptedException {
844 +        final ArrayBlockingQueue q = populatedQueue(SIZE);
845 +        Thread t = new Thread(new CheckedRunnable() {
846 +            public void realRun() throws InterruptedException {
847 +                q.put(new Integer(SIZE+1));
848 +            }});
849 +
850 +        t.start();
851 +        ArrayList l = new ArrayList();
852 +        q.drainTo(l);
853 +        assertTrue(l.size() >= SIZE);
854 +        for (int i = 0; i < SIZE; ++i)
855 +            assertEquals(l.get(i), new Integer(i));
856 +        t.join();
857 +        assertTrue(q.size() + l.size() >= SIZE);
858 +    }
859 +
860 +    /**
861 +     * drainTo(null, n) throws NPE
862 +     */
863 +    public void testDrainToNullN() {
864 +        ArrayBlockingQueue q = populatedQueue(SIZE);
865 +        try {
866 +            q.drainTo(null, 0);
867 +            shouldThrow();
868 +        } catch (NullPointerException success) {}
869 +    }
870 +
871 +    /**
872 +     * drainTo(this, n) throws IAE
873 +     */
874 +    public void testDrainToSelfN() {
875 +        ArrayBlockingQueue q = populatedQueue(SIZE);
876 +        try {
877 +            q.drainTo(q, 0);
878 +            shouldThrow();
879 +        } catch (IllegalArgumentException success) {}
880 +    }
881 +
882 +    /**
883 +     * drainTo(c, n) empties first min(n, size) elements of queue into c
884 +     */
885 +    public void testDrainToN() {
886 +        ArrayBlockingQueue q = new ArrayBlockingQueue(SIZE*2);
887 +        for (int i = 0; i < SIZE + 2; ++i) {
888 +            for (int j = 0; j < SIZE; j++)
889 +                assertTrue(q.offer(new Integer(j)));
890 +            ArrayList l = new ArrayList();
891 +            q.drainTo(l, i);
892 +            int k = (i < SIZE) ? i : SIZE;
893 +            assertEquals(l.size(), k);
894 +            assertEquals(q.size(), SIZE-k);
895 +            for (int j = 0; j < k; ++j)
896 +                assertEquals(l.get(j), new Integer(j));
897 +            while (q.poll() != null) ;
898 +        }
899 +    }
900  
901   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines