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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines