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/licenses/publicdomain |
5 |
|
*/ |
6 |
|
|
7 |
|
package java.util; |
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 |
24 |
> |
* Iterator#remove}. Typically, additional methods will be overridden |
25 |
|
* as well. If these requirements cannot be met, consider instead |
26 |
|
* subclassing {@link AbstractCollection}. |
27 |
|
* |
28 |
+ |
* <p>This class is a member of the |
29 |
+ |
* <a href="{@docRoot}/../guide/collections/index.html"> |
30 |
+ |
* Java Collections Framework</a>. |
31 |
+ |
* |
32 |
|
* @since 1.5 |
33 |
|
* @author Doug Lea |
34 |
+ |
* @param <E> the type of elements held in this collection |
35 |
|
*/ |
36 |
|
public abstract class AbstractQueue<E> |
37 |
|
extends AbstractCollection<E> |
47 |
|
/** |
48 |
|
* Adds the specified element to this queue. This implementation |
49 |
|
* returns <tt>true</tt> if <tt>offer</tt> succeeds, else |
50 |
< |
* throws an IllegalStateException. |
51 |
< |
* |
52 |
< |
* @param o the element |
50 |
> |
* throws an IllegalStateException. |
51 |
> |
* |
52 |
> |
* @param e the element |
53 |
|
* @return <tt>true</tt> (as per the general contract of |
54 |
|
* <tt>Collection.add</tt>). |
55 |
|
* |
56 |
< |
* @throws NullPointerException if the specified element is <tt>null</tt> |
57 |
< |
* @throws IllegalStateException if element cannot be added |
56 |
> |
* @throws NullPointerException if the specified element is <tt>null</tt>. |
57 |
> |
* @throws IllegalStateException if the element cannot be added. |
58 |
|
*/ |
59 |
< |
public boolean add(E o) { |
60 |
< |
if (offer(o)) |
59 |
> |
public boolean add(E e) { |
60 |
> |
if (offer(e)) |
61 |
|
return true; |
62 |
|
else |
63 |
|
throw new IllegalStateException("Queue full"); |
79 |
|
throw new NoSuchElementException(); |
80 |
|
} |
81 |
|
|
77 |
– |
|
82 |
|
/** |
83 |
< |
* Retrieves, but does not remove, the head of this queue. |
83 |
> |
* Retrieves, but does not remove, the head of this queue. |
84 |
|
* This implementation returns the result of <tt>peek</tt> |
85 |
|
* unless the queue is empty. |
86 |
|
* |
96 |
|
} |
97 |
|
|
98 |
|
/** |
99 |
< |
* Removes all of the elements from this collection. |
100 |
< |
* The collection will be empty after this call returns. |
99 |
> |
* Removes all of the elements from this queue. |
100 |
> |
* The queue will be empty after this call returns. |
101 |
|
* <p>This implementation repeatedly invokes {@link #poll poll} until it |
102 |
|
* returns <tt>null</tt>. |
103 |
|
*/ |
105 |
|
while (poll() != null) |
106 |
|
; |
107 |
|
} |
108 |
+ |
|
109 |
+ |
/** |
110 |
+ |
* Adds all of the elements in the specified collection to this |
111 |
+ |
* queue. Attempts to addAll of a queue to itself result in |
112 |
+ |
* <tt>IllegalArgumentException</tt>. Further, the behavior of |
113 |
+ |
* this operation is undefined if the specified collection is |
114 |
+ |
* modified while the operation is in progress. |
115 |
+ |
* |
116 |
+ |
* <p>This implementation iterates over the specified collection, |
117 |
+ |
* and adds each element returned by the iterator to this |
118 |
+ |
* queue, in turn. A runtime exception encountered while |
119 |
+ |
* trying to add an element (including, in particular, a |
120 |
+ |
* <tt>null</tt> element) may result in only some of the elements |
121 |
+ |
* having been successfully added when the associated exception is |
122 |
+ |
* thrown. |
123 |
+ |
* |
124 |
+ |
* @param c collection whose elements are to be added to this queue. |
125 |
+ |
* @return <tt>true</tt> if this queue changed as a result of the |
126 |
+ |
* call. |
127 |
+ |
* @throws NullPointerException if the specified collection or |
128 |
+ |
* any of its elements are null. |
129 |
+ |
* @throws IllegalArgumentException if c is this queue. |
130 |
+ |
* |
131 |
+ |
* @see #add(Object) |
132 |
+ |
*/ |
133 |
+ |
public boolean addAll(Collection<? extends E> c) { |
134 |
+ |
if (c == null) |
135 |
+ |
throw new NullPointerException(); |
136 |
+ |
if (c == this) |
137 |
+ |
throw new IllegalArgumentException(); |
138 |
+ |
boolean modified = false; |
139 |
+ |
Iterator<? extends E> e = c.iterator(); |
140 |
+ |
while (e.hasNext()) { |
141 |
+ |
if (add(e.next())) |
142 |
+ |
modified = true; |
143 |
+ |
} |
144 |
+ |
return modified; |
145 |
+ |
} |
146 |
+ |
|
147 |
|
} |