| 1 |
|
/* |
| 2 |
|
* Written by Doug Lea with assistance from members of JCP JSR-166 |
| 3 |
< |
* Expert Group and released to the public domain. Use, modify, and |
| 4 |
< |
* redistribute this code in any way without acknowledgement. |
| 3 |
> |
* Expert Group and released to the public domain, as explained at |
| 4 |
> |
* http://creativecommons.org/publicdomain/zero/1.0/ |
| 5 |
|
*/ |
| 6 |
|
|
| 7 |
|
package java.util; |
| 8 |
|
|
| 9 |
|
/** |
| 10 |
< |
* A Collection designed for holding elements prior to processing. |
| 11 |
< |
* Besides basic {@link Collection} operations, queues provide |
| 12 |
< |
* additional insertion, extraction, and inspection operations. |
| 13 |
< |
0 * |
| 10 |
> |
* A collection designed for holding elements prior to processing. |
| 11 |
> |
* Besides basic {@link java.util.Collection Collection} operations, |
| 12 |
> |
* queues provide additional insertion, extraction, and inspection |
| 13 |
> |
* operations. Each of these methods exists in two forms: one throws |
| 14 |
> |
* an exception if the operation fails, the other returns a special |
| 15 |
> |
* value (either {@code null} or {@code false}, depending on the |
| 16 |
> |
* operation). The latter form of the insert operation is designed |
| 17 |
> |
* specifically for use with capacity-restricted {@code Queue} |
| 18 |
> |
* implementations; in most implementations, insert operations cannot |
| 19 |
> |
* fail. |
| 20 |
> |
* |
| 21 |
> |
* <p> |
| 22 |
> |
* <table BORDER CELLPADDING=3 CELLSPACING=1> |
| 23 |
> |
* <caption>Summary of Queue methods</caption> |
| 24 |
> |
* <tr> |
| 25 |
> |
* <td></td> |
| 26 |
> |
* <td ALIGN=CENTER><em>Throws exception</em></td> |
| 27 |
> |
* <td ALIGN=CENTER><em>Returns special value</em></td> |
| 28 |
> |
* </tr> |
| 29 |
> |
* <tr> |
| 30 |
> |
* <td><b>Insert</b></td> |
| 31 |
> |
* <td>{@link #add add(e)}</td> |
| 32 |
> |
* <td>{@link #offer offer(e)}</td> |
| 33 |
> |
* </tr> |
| 34 |
> |
* <tr> |
| 35 |
> |
* <td><b>Remove</b></td> |
| 36 |
> |
* <td>{@link #remove remove()}</td> |
| 37 |
> |
* <td>{@link #poll poll()}</td> |
| 38 |
> |
* </tr> |
| 39 |
> |
* <tr> |
| 40 |
> |
* <td><b>Examine</b></td> |
| 41 |
> |
* <td>{@link #element element()}</td> |
| 42 |
> |
* <td>{@link #peek peek()}</td> |
| 43 |
> |
* </tr> |
| 44 |
> |
* </table> |
| 45 |
> |
* |
| 46 |
|
* <p>Queues typically, but do not necessarily, order elements in a |
| 47 |
|
* FIFO (first-in-first-out) manner. Among the exceptions are |
| 48 |
|
* priority queues, which order elements according to a supplied |
| 49 |
< |
* comparator, or the elements' natural ordering. Every Queue |
| 50 |
< |
* implementation must specify its ordering guarantees. |
| 49 |
> |
* comparator, or the elements' natural ordering, and LIFO queues (or |
| 50 |
> |
* stacks) which order the elements LIFO (last-in-first-out). |
| 51 |
> |
* Whatever the ordering used, the <em>head</em> of the queue is that |
| 52 |
> |
* element which would be removed by a call to {@link #remove() } or |
| 53 |
> |
* {@link #poll()}. In a FIFO queue, all new elements are inserted at |
| 54 |
> |
* the <em>tail</em> of the queue. Other kinds of queues may use |
| 55 |
> |
* different placement rules. Every {@code Queue} implementation |
| 56 |
> |
* must specify its ordering properties. |
| 57 |
> |
* |
| 58 |
> |
* <p>The {@link #offer offer} method inserts an element if possible, |
| 59 |
> |
* otherwise returning {@code false}. This differs from the {@link |
| 60 |
> |
* java.util.Collection#add Collection.add} method, which can fail to |
| 61 |
> |
* add an element only by throwing an unchecked exception. The |
| 62 |
> |
* {@code offer} method is designed for use when failure is a normal, |
| 63 |
> |
* rather than exceptional occurrence, for example, in fixed-capacity |
| 64 |
> |
* (or "bounded") queues. |
| 65 |
|
* |
| 20 |
– |
* <p>The {@link #offer(E)} method adds an element if possible, otherwise |
| 21 |
– |
* returning <tt>false</tt>. This differs from the {@link |
| 22 |
– |
* Collections#add(Object)} method, which throws an unchecked exception upon |
| 23 |
– |
* failure. It is designed for use in collections in which failure to |
| 24 |
– |
* add is a normal, rather than exceptional occurrence, for example, |
| 25 |
– |
* in fixed-capacity (or “bounded”) queues. |
| 26 |
– |
|
| 27 |
– |
* |
| 66 |
|
* <p>The {@link #remove()} and {@link #poll()} methods remove and |
| 67 |
< |
* return an element in accord with the implementation's ordering |
| 68 |
< |
* policy. Exactly which element is removed from the queue is a |
| 67 |
> |
* return the head of the queue. |
| 68 |
> |
* Exactly which element is removed from the queue is a |
| 69 |
|
* function of the queue's ordering policy, which differs from |
| 70 |
< |
* implementation to implementation. Possible orderings include (but |
| 71 |
< |
* are not limited to) first-in-first-out (FIFO), last-in-first-out |
| 72 |
< |
* (LIFO), element priority, and arbitrary. The <tt>remove()</tt> and |
| 73 |
< |
* <tt>poll()</tt> methods differ only in their behavior when the |
| 36 |
< |
* queue is empty: the <tt>remove()</tt> method throws an exception, |
| 37 |
< |
* while the <tt>poll()</tt> method returns <tt>null</tt>. |
| 38 |
< |
* |
| 39 |
< |
* <p>The {@link #element()} and {@link #peek()} methods return but do |
| 40 |
< |
* not delete the element that would be obtained by a call to |
| 41 |
< |
* the <tt>remove</tt> and <tt>poll</tt> methods respectively. |
| 70 |
> |
* implementation to implementation. The {@code remove()} and |
| 71 |
> |
* {@code poll()} methods differ only in their behavior when the |
| 72 |
> |
* queue is empty: the {@code remove()} method throws an exception, |
| 73 |
> |
* while the {@code poll()} method returns {@code null}. |
| 74 |
|
* |
| 75 |
< |
* <p>The <tt>Queue</tt> interface does not define the <i>blocking queue |
| 75 |
> |
* <p>The {@link #element()} and {@link #peek()} methods return, but do |
| 76 |
> |
* not remove, the head of the queue. |
| 77 |
> |
* |
| 78 |
> |
* <p>The {@code Queue} interface does not define the <i>blocking queue |
| 79 |
|
* methods</i>, which are common in concurrent programming. These methods, |
| 80 |
|
* which wait for elements to appear or for space to become available, are |
| 81 |
|
* defined in the {@link java.util.concurrent.BlockingQueue} interface, which |
| 82 |
|
* extends this interface. |
| 83 |
|
* |
| 84 |
< |
* <p><tt>Queue</tt> implementations generally do not allow insertion |
| 85 |
< |
* of <tt>null</tt> elements, although some implementations, such as |
| 86 |
< |
* {@link LinkedList}, do not prohibit insertion of <tt>null</tt>. |
| 87 |
< |
* Even in the implementations that permit it, <tt>null</tt> should |
| 88 |
< |
* not be inserted into a <tt>Queue</tt>, as <tt>null</tt> is also |
| 89 |
< |
* used as a special return value by the <tt>poll</tt> method to |
| 84 |
> |
* <p>{@code Queue} implementations generally do not allow insertion |
| 85 |
> |
* of {@code null} elements, although some implementations, such as |
| 86 |
> |
* {@link LinkedList}, do not prohibit insertion of {@code null}. |
| 87 |
> |
* Even in the implementations that permit it, {@code null} should |
| 88 |
> |
* not be inserted into a {@code Queue}, as {@code null} is also |
| 89 |
> |
* used as a special return value by the {@code poll} method to |
| 90 |
|
* indicate that the queue contains no elements. |
| 91 |
|
* |
| 92 |
+ |
* <p>{@code Queue} implementations generally do not define |
| 93 |
+ |
* element-based versions of methods {@code equals} and |
| 94 |
+ |
* {@code hashCode} but instead inherit the identity based versions |
| 95 |
+ |
* from class {@code Object}, because element-based equality is not |
| 96 |
+ |
* always well-defined for queues with the same elements but different |
| 97 |
+ |
* ordering properties. |
| 98 |
+ |
* |
| 99 |
+ |
* |
| 100 |
|
* <p>This interface is a member of the |
| 101 |
< |
* <a href="{@docRoot}/../guide/collections/index.html"> |
| 101 |
> |
* <a href="{@docRoot}/../technotes/guides/collections/index.html"> |
| 102 |
|
* Java Collections Framework</a>. |
| 103 |
|
* |
| 104 |
< |
* @see Collection |
| 104 |
> |
* @see java.util.Collection |
| 105 |
|
* @see LinkedList |
| 106 |
|
* @see PriorityQueue |
| 107 |
< |
* @see java.util.concurrent.LinkedQueue |
| 107 |
> |
* @see java.util.concurrent.LinkedBlockingQueue |
| 108 |
|
* @see java.util.concurrent.BlockingQueue |
| 109 |
|
* @see java.util.concurrent.ArrayBlockingQueue |
| 110 |
|
* @see java.util.concurrent.LinkedBlockingQueue |
| 111 |
|
* @see java.util.concurrent.PriorityBlockingQueue |
| 112 |
|
* @since 1.5 |
| 113 |
|
* @author Doug Lea |
| 114 |
+ |
* @param <E> the type of elements held in this collection |
| 115 |
|
*/ |
| 116 |
|
public interface Queue<E> extends Collection<E> { |
| 117 |
|
/** |
| 118 |
< |
* Add the specified element to this queue, if possible. |
| 118 |
> |
* Inserts the specified element into this queue if it is possible to do so |
| 119 |
> |
* immediately without violating capacity restrictions, returning |
| 120 |
> |
* {@code true} upon success and throwing an {@code IllegalStateException} |
| 121 |
> |
* if no space is currently available. |
| 122 |
|
* |
| 123 |
< |
* @param element the element to add. |
| 124 |
< |
* @return true if it was possible to add the element to the queue. |
| 123 |
> |
* @param e the element to add |
| 124 |
> |
* @return {@code true} (as specified by {@link Collection#add}) |
| 125 |
> |
* @throws IllegalStateException if the element cannot be added at this |
| 126 |
> |
* time due to capacity restrictions |
| 127 |
> |
* @throws ClassCastException if the class of the specified element |
| 128 |
> |
* prevents it from being added to this queue |
| 129 |
> |
* @throws NullPointerException if the specified element is null and |
| 130 |
> |
* this queue does not permit null elements |
| 131 |
> |
* @throws IllegalArgumentException if some property of this element |
| 132 |
> |
* prevents it from being added to this queue |
| 133 |
|
*/ |
| 134 |
< |
boolean offer(E element); |
| 134 |
> |
boolean add(E e); |
| 135 |
|
|
| 136 |
|
/** |
| 137 |
< |
* Remove and return an element from the queue if one is available. |
| 137 |
> |
* Inserts the specified element into this queue if it is possible to do |
| 138 |
> |
* so immediately without violating capacity restrictions. |
| 139 |
> |
* When using a capacity-restricted queue, this method is generally |
| 140 |
> |
* preferable to {@link #add}, which can fail to insert an element only |
| 141 |
> |
* by throwing an exception. |
| 142 |
|
* |
| 143 |
< |
* @return an element previously on the queue, or <tt>null</tt> if the |
| 144 |
< |
* queue is empty. |
| 143 |
> |
* @param e the element to add |
| 144 |
> |
* @return {@code true} if the element was added to this queue, else |
| 145 |
> |
* {@code false} |
| 146 |
> |
* @throws ClassCastException if the class of the specified element |
| 147 |
> |
* prevents it from being added to this queue |
| 148 |
> |
* @throws NullPointerException if the specified element is null and |
| 149 |
> |
* this queue does not permit null elements |
| 150 |
> |
* @throws IllegalArgumentException if some property of this element |
| 151 |
> |
* prevents it from being added to this queue |
| 152 |
|
*/ |
| 153 |
< |
E poll(); |
| 153 |
> |
boolean offer(E e); |
| 154 |
|
|
| 155 |
|
/** |
| 156 |
< |
* Remove and return an element from the queue. This method differs |
| 157 |
< |
* from the <tt>poll</tt> method in that it throws an exception if the |
| 158 |
< |
* queue is empty. |
| 156 |
> |
* Retrieves and removes the head of this queue. This method differs |
| 157 |
> |
* from {@link #poll poll} only in that it throws an exception if this |
| 158 |
> |
* queue is empty. |
| 159 |
|
* |
| 160 |
< |
* @return an element previously on the queue. |
| 161 |
< |
* @throws NoSuchElementException if the queue is empty. |
| 160 |
> |
* @return the head of this queue |
| 161 |
> |
* @throws NoSuchElementException if this queue is empty |
| 162 |
|
*/ |
| 163 |
< |
E remove() throws NoSuchElementException; |
| 163 |
> |
E remove(); |
| 164 |
|
|
| 165 |
|
/** |
| 166 |
< |
* Return, but do not remove, an element from the queue, or <tt>null</tt> |
| 167 |
< |
* if the queue is empty. This method returns the same object reference |
| 102 |
< |
* that would be returned by by the <tt>poll</tt> method. The two methods |
| 103 |
< |
* differ in that this method does not remove the element from the queue. |
| 166 |
> |
* Retrieves and removes the head of this queue, |
| 167 |
> |
* or returns {@code null} if this queue is empty. |
| 168 |
|
* |
| 169 |
< |
* @return an element on the queue, or <tt>null</tt> if the queue is empty. |
| 169 |
> |
* @return the head of this queue, or {@code null} if this queue is empty |
| 170 |
|
*/ |
| 171 |
< |
E peek(); |
| 171 |
> |
E poll(); |
| 172 |
|
|
| 173 |
|
/** |
| 174 |
< |
* Return, but do not remove, an element from the queue. This method |
| 175 |
< |
* differs from the <tt>peek</tt> method in that it throws an exception if |
| 176 |
< |
* the queue is empty. |
| 174 |
> |
* Retrieves, but does not remove, the head of this queue. This method |
| 175 |
> |
* differs from {@link #peek peek} only in that it throws an exception |
| 176 |
> |
* if this queue is empty. |
| 177 |
|
* |
| 178 |
< |
* @return an element on the queue. |
| 179 |
< |
* @throws NoSuchElementException if the queue is empty. |
| 178 |
> |
* @return the head of this queue |
| 179 |
> |
* @throws NoSuchElementException if this queue is empty |
| 180 |
|
*/ |
| 181 |
< |
E element() throws NoSuchElementException; |
| 181 |
> |
E element(); |
| 182 |
> |
|
| 183 |
> |
/** |
| 184 |
> |
* Retrieves, but does not remove, the head of this queue, |
| 185 |
> |
* or returns {@code null} if this queue is empty. |
| 186 |
> |
* |
| 187 |
> |
* @return the head of this queue, or {@code null} if this queue is empty |
| 188 |
> |
*/ |
| 189 |
> |
E peek(); |
| 190 |
|
} |
