7 |
|
package java.util; |
8 |
|
|
9 |
|
/** |
10 |
< |
* A Collection designed for holding elements prior to processing. |
11 |
< |
* Besides basic {@link Collection} operations, queues provide |
10 |
> |
* A collection designed for holding elements prior to processing. |
11 |
> |
* Besides basic {@link java.util.Collection Collection} operations, queues provide |
12 |
|
* additional insertion, extraction, and inspection operations. |
13 |
< |
0 * |
13 |
> |
* |
14 |
|
* <p>Queues typically, but do not necessarily, order elements in a |
15 |
|
* FIFO (first-in-first-out) manner. Among the exceptions are |
16 |
|
* priority queues, which order elements according to a supplied |
17 |
< |
* comparator, or the elements' natural ordering. Every Queue |
18 |
< |
* implementation must specify its ordering guarantees. |
17 |
> |
* comparator, or the elements' natural ordering, and LIFO queues (or |
18 |
> |
* stacks) which order the elements LIFO (last-in-first-out). |
19 |
> |
* Whatever the ordering used, the <em>head</em> of the queue is that element |
20 |
> |
* which would be removed by a call to {@link #remove() } or {@link #poll()}. |
21 |
> |
* Every <tt>Queue</tt> implementation must specify its ordering guarantees. |
22 |
|
* |
23 |
|
* <p>The {@link #offer(E)} method adds an element if possible, otherwise |
24 |
< |
* returning <tt>false</tt>. This differs from the {@link |
25 |
< |
* Collections#add(Object)} method, which throws an unchecked exception upon |
24 |
> |
* returning <tt>false</tt>. This differs from the {@link java.util.Collection#add Collection.add(E)} |
25 |
> |
* method, which throws an unchecked exception upon |
26 |
|
* failure. It is designed for use in collections in which failure to |
27 |
|
* add is a normal, rather than exceptional occurrence, for example, |
28 |
< |
* in fixed-capacity (or “bounded”) queues. |
29 |
< |
|
27 |
< |
* |
28 |
> |
* in fixed-capacity (or "bounded") queues. |
29 |
> |
* |
30 |
|
* <p>The {@link #remove()} and {@link #poll()} methods remove and |
31 |
< |
* return an element in accord with the implementation's ordering |
32 |
< |
* policy. Exactly which element is removed from the queue is a |
31 |
> |
* return the head of the queue. |
32 |
> |
* Exactly which element is removed from the queue is a |
33 |
|
* function of the queue's ordering policy, which differs from |
34 |
< |
* implementation to implementation. Possible orderings include (but |
33 |
< |
* are not limited to) first-in-first-out (FIFO), last-in-first-out |
34 |
< |
* (LIFO), element priority, and arbitrary. The <tt>remove()</tt> and |
34 |
> |
* implementation to implementation. The <tt>remove()</tt> and |
35 |
|
* <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. |
39 |
> |
* <p>The {@link #element()} and {@link #peek()} methods return, but do |
40 |
> |
* not remove, the head of the queue. |
41 |
|
* |
42 |
|
* <p>The <tt>Queue</tt> interface does not define the <i>blocking queue |
43 |
|
* methods</i>, which are common in concurrent programming. These methods, |
57 |
|
* <a href="{@docRoot}/../guide/collections/index.html"> |
58 |
|
* Java Collections Framework</a>. |
59 |
|
* |
60 |
< |
* @see Collection |
60 |
> |
* @see java.util.Collection |
61 |
|
* @see LinkedList |
62 |
|
* @see PriorityQueue |
63 |
|
* @see java.util.concurrent.LinkedQueue |
69 |
|
* @author Doug Lea |
70 |
|
*/ |
71 |
|
public interface Queue<E> extends Collection<E> { |
72 |
+ |
|
73 |
|
/** |
74 |
|
* Add the specified element to this queue, if possible. |
75 |
|
* |
76 |
< |
* @param element the element to add. |
77 |
< |
* @return true if it was possible to add the element to the queue. |
76 |
> |
* @param o the element to add. |
77 |
> |
* @return <tt>true</tt> if it was possible to add the element to |
78 |
> |
* this queue, else <tt>false</tt> |
79 |
|
*/ |
80 |
< |
boolean offer(E element); |
80 |
> |
boolean offer(E o); |
81 |
|
|
82 |
|
/** |
83 |
< |
* Remove and return an element from the queue if one is available. |
83 |
> |
* Retrieve and remove the head of this queue, if it is available. |
84 |
|
* |
85 |
< |
* @return an element previously on the queue, or <tt>null</tt> if the |
86 |
< |
* queue is empty. |
85 |
> |
* @return the head of this queue, or <tt>null</tt> if this |
86 |
> |
* queue is empty. |
87 |
|
*/ |
88 |
|
E poll(); |
89 |
|
|
90 |
|
/** |
91 |
< |
* Remove and return an element from the queue. This method differs |
92 |
< |
* from the <tt>poll</tt> method in that it throws an exception if the |
93 |
< |
* queue is empty. |
91 |
> |
* Retrieve and remove the head of this queue. |
92 |
> |
* This method differs |
93 |
> |
* from the <tt>poll</tt> method in that it throws an exception if this |
94 |
> |
* queue is empty. |
95 |
|
* |
96 |
< |
* @return an element previously on the queue. |
97 |
< |
* @throws NoSuchElementException if the queue is empty. |
96 |
> |
* @return the head of this queue. |
97 |
> |
* @throws NoSuchElementException if this queue is empty. |
98 |
|
*/ |
99 |
< |
E remove() throws NoSuchElementException; |
99 |
> |
E remove(); |
100 |
|
|
101 |
|
/** |
102 |
< |
* Return, but do not remove, an element from the queue, or <tt>null</tt> |
103 |
< |
* if the queue is empty. This method returns the same object reference |
104 |
< |
* that would be returned by by the <tt>poll</tt> method. The two methods |
105 |
< |
* differ in that this method does not remove the element from the queue. |
102 |
> |
* Retrieve, but do not remove, the head of this queue. |
103 |
> |
* This method differs from the <tt>poll</tt> |
104 |
> |
* method only in that this method does not remove the head element from |
105 |
> |
* this queue. |
106 |
|
* |
107 |
< |
* @return an element on the queue, or <tt>null</tt> if the queue is empty. |
107 |
> |
* @return the head of this queue, or <tt>null</tt> if this queue is empty. |
108 |
|
*/ |
109 |
|
E peek(); |
110 |
|
|
111 |
|
/** |
112 |
< |
* Return, but do not remove, an element from the queue. This method |
113 |
< |
* differs from the <tt>peek</tt> method in that it throws an exception if |
114 |
< |
* the queue is empty. |
112 |
> |
* Retrieve, but do not remove, the head of this queue. This method |
113 |
> |
* differs from the <tt>peek</tt> method only in that it throws an |
114 |
> |
* exception if this queue is empty. |
115 |
|
* |
116 |
< |
* @return an element on the queue. |
117 |
< |
* @throws NoSuchElementException if the queue is empty. |
116 |
> |
* @return the head of this queue. |
117 |
> |
* @throws NoSuchElementException if this queue is empty. |
118 |
|
*/ |
119 |
< |
E element() throws NoSuchElementException; |
119 |
> |
E element(); |
120 |
|
} |
121 |
+ |
|
122 |
+ |
|
123 |
+ |
|
124 |
+ |
|
125 |
+ |
|
126 |
+ |
|
127 |
+ |
|
128 |
+ |
|
129 |
+ |
|
130 |
+ |
|