sample/java.util.concurrent.DelayQueue.txt

   1 *java.util.concurrent.DelayQueue* *DelayQueue* An unboundedBlockingQueue blockin
   2
   3 public class DelayQueue
   4   extends    |java.util.AbstractQueue|
   5   implements |java.util.concurrent.BlockingQueue|
   6
   7 |java.util.concurrent.DelayQueue_Description|
   8 |java.util.concurrent.DelayQueue_Fields|
   9 |java.util.concurrent.DelayQueue_Constructors|
  10 |java.util.concurrent.DelayQueue_Methods|
  11
  12 ================================================================================
  13
  14 *java.util.concurrent.DelayQueue_Constructors*
  15 |java.util.concurrent.DelayQueue()|Creates a new DelayQueue that is initially e
  16 |java.util.concurrent.DelayQueue(Collection)|Creates a DelayQueue initially con
  17
  18 *java.util.concurrent.DelayQueue_Methods*
  19 |java.util.concurrent.DelayQueue.add(E)|Adds the specified element to this queu
  20 |java.util.concurrent.DelayQueue.clear()|Atomically removes all of the elements
  21 |java.util.concurrent.DelayQueue.drainTo(Collection)|
  22 |java.util.concurrent.DelayQueue.drainTo(Collection,int)|
  23 |java.util.concurrent.DelayQueue.iterator()|Returns an iterator over the elemen
  24 |java.util.concurrent.DelayQueue.offer(E)|Inserts the specified element into th
  25 |java.util.concurrent.DelayQueue.offer(E,long,TimeUnit)|Inserts the specified e
  26 |java.util.concurrent.DelayQueue.peek()|Retrieves, but does not remove, the hea
  27 |java.util.concurrent.DelayQueue.poll()|Retrieves and removes the head of this
  28 |java.util.concurrent.DelayQueue.poll(long,TimeUnit)|Retrieves and removes the
  29 |java.util.concurrent.DelayQueue.put(E)|Adds the specified element to this dela
  30 |java.util.concurrent.DelayQueue.remainingCapacity()|Always returns Integer.MAX
  31 |java.util.concurrent.DelayQueue.remove(Object)|Removes a single instance of th
  32 |java.util.concurrent.DelayQueue.size()|
  33 |java.util.concurrent.DelayQueue.take()|Retrieves and removes the head of this
  34 |java.util.concurrent.DelayQueue.toArray()|
  35 |java.util.concurrent.DelayQueue.toArray(T[])|
  36
  37 *java.util.concurrent.DelayQueue_Description*
  38
  39 An unbounded blocking queue(|java.util.concurrent.BlockingQueue|) of Delayed
  40 elements, in which an element can only be taken when its delay has expired. The
  41 head of the queue is that Delayed element whose delay expired furthest in the
  42 past. If no delay has expired there is no head and poll will return null.
  43 Expiration occurs when an element's getDelay(TimeUnit.NANOSECONDS) method
  44 returns a value less than or equal to zero. This queue does not permit null
  45 elements.
  46
  47 This class and its iterator implement all of the optional methods of the
  48 (|java.util.Collection|) and (|java.util.Iterator|) interfaces.
  49
  50 This class is a member of the <a href="/../guide/collections/index.html"> Java
  51 Collections Framework.
  52
  53
  54 *java.util.concurrent.DelayQueue()*
  55
  56 public DelayQueue()
  57
  58 Creates a new DelayQueue that is initially empty.
  59
  60
  61 *java.util.concurrent.DelayQueue(Collection)*
  62
  63 public DelayQueue(java.util.Collection c)
  64
  65 Creates a DelayQueue initially containing the elements of the given collection
  66 of (|java.util.concurrent.Delayed|) instances.
  67
  68     c - the collection
  69
  70 *java.util.concurrent.DelayQueue.add(E)*
  71
  72 public boolean add(java.util.concurrent.Delayed o)
  73
  74 Adds the specified element to this queue.
  75
  76     o - the element to add
  77
  78     Returns: true (as per the general contract of Collection.add).
  79 *java.util.concurrent.DelayQueue.clear()*
  80
  81 public void clear()
  82
  83 Atomically removes all of the elements from this delay queue. The queue will be
  84 empty after this call returns.
  85
  86
  87 *java.util.concurrent.DelayQueue.drainTo(Collection)*
  88
  89 public int drainTo(java.util.Collection c)
  90
  91
  92
  93
  94 *java.util.concurrent.DelayQueue.drainTo(Collection,int)*
  95
  96 public int drainTo(
  97   java.util.Collection c,
  98   int maxElements)
  99
 100
 101
 102
 103 *java.util.concurrent.DelayQueue.iterator()*
 104
 105 public |java.util.Iterator| iterator()
 106
 107 Returns an iterator over the elements in this queue. The iterator does not
 108 return the elements in any particular order. The returned iterator is a
 109 thread-safe "fast-fail" iterator that will throw
 110 (|java.util.ConcurrentModificationException|) upon detected interference.
 111
 112
 113     Returns: an iterator over the elements in this queue.
 114 *java.util.concurrent.DelayQueue.offer(E)*
 115
 116 public boolean offer(java.util.concurrent.Delayed o)
 117
 118 Inserts the specified element into this delay queue.
 119
 120     o - the element to add
 121
 122     Returns:
 123 *java.util.concurrent.DelayQueue.offer(E,long,TimeUnit)*
 124
 125 public boolean offer(
 126   java.util.concurrent.Delayed o,
 127   long timeout,
 128   java.util.concurrent.TimeUnit unit)
 129
 130 Inserts the specified element into this delay queue. As the queue is unbounded
 131 this method will never block.
 132
 133     o - the element to add
 134     timeout - This parameter is ignored as the method never blocks
 135     unit - This parameter is ignored as the method never blocks
 136
 137     Returns:
 138 *java.util.concurrent.DelayQueue.peek()*
 139
 140 public |java.util.concurrent.Delayed| peek()
 141
 142 Retrieves, but does not remove, the head of this queue, returning null if this
 143 queue has no elements with an unexpired delay.
 144
 145
 146     Returns: the head of this queue, or null if this queue has no elements with an unexpired
 147              delay.
 148 *java.util.concurrent.DelayQueue.poll()*
 149
 150 public |java.util.concurrent.Delayed| poll()
 151
 152 Retrieves and removes the head of this queue, or null if this queue has no
 153 elements with an unexpired delay.
 154
 155
 156     Returns: the head of this queue, or null if this queue has no elements with an unexpired
 157              delay.
 158 *java.util.concurrent.DelayQueue.poll(long,TimeUnit)*
 159
 160 public |java.util.concurrent.Delayed| poll(
 161   long timeout,
 162   java.util.concurrent.TimeUnit unit)
 163   throws |java.lang.InterruptedException|
 164
 165 Retrieves and removes the head of this queue, waiting if necessary up to the
 166 specified wait time if no elements with an unexpired delay are present on this
 167 queue.
 168
 169     timeout - how long to wait before giving up, in units of unit
 170     unit - a TimeUnit determining how to interpret the timeout parameter
 171
 172     Returns: the head of this queue, or null if the specified waiting time elapses before an
 173              element with an unexpired delay is present.
 174 *java.util.concurrent.DelayQueue.put(E)*
 175
 176 public void put(java.util.concurrent.Delayed o)
 177
 178 Adds the specified element to this delay queue. As the queue is unbounded this
 179 method will never block.
 180
 181     o - the element to add
 182
 183 *java.util.concurrent.DelayQueue.remainingCapacity()*
 184
 185 public int remainingCapacity()
 186
 187 Always returns Integer.MAX_VALUE because a DelayQueue is not capacity
 188 constrained.
 189
 190
 191     Returns: Integer.MAX_VALUE
 192 *java.util.concurrent.DelayQueue.remove(Object)*
 193
 194 public boolean remove(java.lang.Object o)
 195
 196 Removes a single instance of the specified element from this queue, if it is
 197 present.
 198
 199
 200 *java.util.concurrent.DelayQueue.size()*
 201
 202 public int size()
 203
 204
 205
 206
 207 *java.util.concurrent.DelayQueue.take()*
 208
 209 public |java.util.concurrent.Delayed| take()
 210   throws |java.lang.InterruptedException|
 211
 212 Retrieves and removes the head of this queue, waiting if no elements with an
 213 unexpired delay are present on this queue.
 214
 215
 216     Returns: the head of this queue
 217 *java.util.concurrent.DelayQueue.toArray()*
 218
 219 public |java.lang.Object| toArray()
 220
 221
 222
 223
 224 *java.util.concurrent.DelayQueue.toArray(T[])*
 225
 226 public |java.lang.Object| toArray(java.lang.Object[] array)
 227
 228
 229
 230
 231