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.77 by jsr166, Thu Sep 15 17:07:16 2016 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines