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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines