7 |
|
package java.util; |
8 |
|
|
9 |
|
/** |
10 |
< |
* AbstractQueue provides default implementations of add, remove, and |
11 |
< |
* element based on offer, poll, and peek, respectively but that throw |
12 |
< |
* exceptions instead of indicating failure via false or null returns. |
13 |
< |
* The provided implementations all assume that the base implementation |
14 |
< |
* does <em>not</em> allow <tt>null</tt> elements. |
10 |
> |
* This class provides skeletal implementations of some {@link Queue} |
11 |
> |
* operations. The implementations in this class are appropriate when |
12 |
> |
* the base implementation does <em>not</em> allow <tt>null</tt> |
13 |
> |
* elements. Methods {@link #add add}, {@link #remove remove}, and |
14 |
> |
* {@link #element element} are based on {@link #offer offer}, {@link |
15 |
> |
* #poll poll}, and {@link #peek peek}, respectively but throw |
16 |
> |
* exceptions instead of indicating failure via <tt>false</tt> or |
17 |
> |
* <tt>null</tt> returns. |
18 |
> |
* |
19 |
> |
* <p> A <tt>Queue</tt> implementation that extends this class must |
20 |
> |
* minimally define a method {@link Queue#offer} which does not permit |
21 |
> |
* insertion of <tt>null</tt> elements, along with methods {@link |
22 |
> |
* Queue#peek}, {@link Queue#poll}, {@link Collection#size}, and a |
23 |
> |
* {@link Collection#iterator} supporting {@link |
24 |
> |
* Iterator#remove}. Typically, additional methods will be overriden |
25 |
> |
* as well. If these requirements cannot be met, consider instead |
26 |
> |
* subclassing {@link AbstractCollection}. |
27 |
> |
* |
28 |
|
* @since 1.5 |
29 |
|
* @author Doug Lea |
30 |
|
*/ |
31 |
+ |
public abstract class AbstractQueue<E> |
32 |
+ |
extends AbstractCollection<E> |
33 |
+ |
implements Queue<E> { |
34 |
+ |
|
35 |
+ |
/** |
36 |
+ |
* Constructor for use by subclasses. |
37 |
+ |
*/ |
38 |
+ |
protected AbstractQueue() { |
39 |
+ |
} |
40 |
|
|
19 |
– |
public abstract class AbstractQueue<E> extends AbstractCollection<E> implements Queue<E> { |
41 |
|
|
42 |
< |
public boolean add(E x) { |
43 |
< |
if (offer(x)) |
42 |
> |
/** |
43 |
> |
* Adds the specified element to this queue. This implementation |
44 |
> |
* returns <tt>true</tt> if <tt>offer</tt> succeeds, else |
45 |
> |
* throws an IllegalStateException. |
46 |
> |
* th |
47 |
> |
* @param o the element |
48 |
> |
* @return <tt>true</tt> (as per the general contract of |
49 |
> |
* <tt>Collection.add</tt>). |
50 |
> |
* |
51 |
> |
* @throws NullPointerException if the specified element is <tt>null</tt> |
52 |
> |
* @throws IllegalStateException if element cannot be added |
53 |
> |
*/ |
54 |
> |
public boolean add(E o) { |
55 |
> |
if (offer(o)) |
56 |
|
return true; |
57 |
|
else |
58 |
|
throw new IllegalStateException("Queue full"); |
59 |
|
} |
60 |
|
|
61 |
+ |
/** |
62 |
+ |
* Retrieves and removes the head of this queue. |
63 |
+ |
* This implementation returns the result of <tt>poll</tt> |
64 |
+ |
* unless the queue is empty. |
65 |
+ |
* |
66 |
+ |
* @return the head of this queue. |
67 |
+ |
* @throws NoSuchElementException if this queue is empty. |
68 |
+ |
*/ |
69 |
|
public E remove() { |
70 |
|
E x = poll(); |
71 |
|
if (x != null) |
74 |
|
throw new NoSuchElementException(); |
75 |
|
} |
76 |
|
|
77 |
+ |
|
78 |
+ |
/** |
79 |
+ |
* Retrieves, but does not remove, the head of this queue. |
80 |
+ |
* This implementation returns the result of <tt>peek</tt> |
81 |
+ |
* unless the queue is empty. |
82 |
+ |
* |
83 |
+ |
* @return the head of this queue. |
84 |
+ |
* @throws NoSuchElementException if this queue is empty. |
85 |
+ |
*/ |
86 |
|
public E element() { |
87 |
|
E x = peek(); |
88 |
|
if (x != null) |
91 |
|
throw new NoSuchElementException(); |
92 |
|
} |
93 |
|
|
94 |
+ |
/** |
95 |
+ |
* Removes all of the elements from this collection. |
96 |
+ |
* The collection will be empty after this call returns. |
97 |
+ |
* <p>This implementation repeatedly invokes {@link #poll poll} until it |
98 |
+ |
* returns <tt>null</tt>. |
99 |
+ |
*/ |
100 |
|
public void clear() { |
101 |
|
while (poll() != null) |
102 |
|
; |
103 |
|
} |
48 |
– |
|
49 |
– |
// XXX Remove this redundant declaration, pending response from Neal Gafter. |
50 |
– |
public abstract Iterator<E> iterator(); |
104 |
|
} |
52 |
– |
|
53 |
– |
|
54 |
– |
|
55 |
– |
|
56 |
– |
|