4 |
|
*/ |
5 |
|
|
6 |
|
package java.util; |
7 |
+ |
import java.util.*; // for javadoc (till 6280605 is fixed) |
8 |
|
import java.io.*; |
9 |
|
|
10 |
|
/** |
19 |
|
* <p>Most <tt>ArrayDeque</tt> operations run in amortized constant time. |
20 |
|
* Exceptions include {@link #remove(Object) remove}, {@link |
21 |
|
* #removeFirstOccurrence removeFirstOccurrence}, {@link #removeLastOccurrence |
22 |
< |
* removeLastOccurrence}, {@link #contains contains }, {@link #iterator |
22 |
> |
* removeLastOccurrence}, {@link #contains contains}, {@link #iterator |
23 |
|
* iterator.remove()}, and the bulk operations, all of which run in linear |
24 |
|
* time. |
25 |
|
* |
41 |
|
* should be used only to detect bugs.</i> |
42 |
|
* |
43 |
|
* <p>This class and its iterator implement all of the |
44 |
< |
* optional methods of the {@link Collection} and {@link |
45 |
< |
* Iterator} interfaces. This class is a member of the <a |
46 |
< |
* href="{@docRoot}/../guide/collections/index.html"> Java Collections |
47 |
< |
* Framework</a>. |
44 |
> |
* <em>optional</em> methods of the {@link Collection} and {@link |
45 |
> |
* Iterator} interfaces. |
46 |
> |
* |
47 |
> |
* <p>This class is a member of the |
48 |
> |
* <a href="{@docRoot}/../guide/collections/index.html"> |
49 |
> |
* Java Collections Framework</a>. |
50 |
|
* |
51 |
|
* @author Josh Bloch and Doug Lea |
52 |
|
* @since 1.6 |
91 |
|
/** |
92 |
|
* Allocate empty array to hold the given number of elements. |
93 |
|
* |
94 |
< |
* @param numElements the number of elements to hold. |
94 |
> |
* @param numElements the number of elements to hold |
95 |
|
*/ |
96 |
|
private void allocateElements(int numElements) { |
97 |
|
int initialCapacity = MIN_INITIAL_CAPACITY; |
190 |
|
/** |
191 |
|
* Inserts the specified element at the front of this deque. |
192 |
|
* |
193 |
< |
* @param e the element to insert |
194 |
< |
* @throws NullPointerException if <tt>e</tt> is null |
193 |
> |
* @param e the element to add |
194 |
> |
* @throws NullPointerException if the specified element is null |
195 |
|
*/ |
196 |
|
public void addFirst(E e) { |
197 |
|
if (e == null) |
203 |
|
|
204 |
|
/** |
205 |
|
* Inserts the specified element at the end of this deque. |
203 |
– |
* This method is equivalent to {@link Collection#add} and |
204 |
– |
* {@link #push}. |
206 |
|
* |
207 |
< |
* @param e the element to insert |
208 |
< |
* @throws NullPointerException if <tt>e</tt> is null |
207 |
> |
* <p>This method is equivalent to {@link #add}. |
208 |
> |
* |
209 |
> |
* @param e the element to add |
210 |
> |
* @throws NullPointerException if the specified element is null |
211 |
|
*/ |
212 |
|
public void addLast(E e) { |
213 |
|
if (e == null) |
218 |
|
} |
219 |
|
|
220 |
|
/** |
218 |
– |
* Retrieves and removes the first element of this deque, or |
219 |
– |
* <tt>null</tt> if this deque is empty. |
220 |
– |
* |
221 |
– |
* @return the first element of this deque, or <tt>null</tt> if |
222 |
– |
* this deque is empty |
223 |
– |
*/ |
224 |
– |
public E pollFirst() { |
225 |
– |
int h = head; |
226 |
– |
E result = elements[h]; // Element is null if deque empty |
227 |
– |
if (result == null) |
228 |
– |
return null; |
229 |
– |
elements[h] = null; // Must null out slot |
230 |
– |
head = (h + 1) & (elements.length - 1); |
231 |
– |
return result; |
232 |
– |
} |
233 |
– |
|
234 |
– |
/** |
235 |
– |
* Retrieves and removes the last element of this deque, or |
236 |
– |
* <tt>null</tt> if this deque is empty. |
237 |
– |
* |
238 |
– |
* @return the last element of this deque, or <tt>null</tt> if |
239 |
– |
* this deque is empty |
240 |
– |
*/ |
241 |
– |
public E pollLast() { |
242 |
– |
int t = (tail - 1) & (elements.length - 1); |
243 |
– |
E result = elements[t]; |
244 |
– |
if (result == null) |
245 |
– |
return null; |
246 |
– |
elements[t] = null; |
247 |
– |
tail = t; |
248 |
– |
return result; |
249 |
– |
} |
250 |
– |
|
251 |
– |
/** |
221 |
|
* Inserts the specified element at the front of this deque. |
222 |
|
* |
223 |
< |
* @param e the element to insert |
224 |
< |
* @return <tt>true</tt> (as per the spec for {@link Deque#offerFirst}) |
225 |
< |
* @throws NullPointerException if <tt>e</tt> is null |
223 |
> |
* @param e the element to add |
224 |
> |
* @return <tt>true</tt> (as specified by {@link Deque#offerFirst}) |
225 |
> |
* @throws NullPointerException if the specified element is null |
226 |
|
*/ |
227 |
|
public boolean offerFirst(E e) { |
228 |
|
addFirst(e); |
232 |
|
/** |
233 |
|
* Inserts the specified element at the end of this deque. |
234 |
|
* |
235 |
< |
* @param e the element to insert |
236 |
< |
* @return <tt>true</tt> (as per the spec for {@link Deque#offerLast}) |
237 |
< |
* @throws NullPointerException if <tt>e</tt> is null |
235 |
> |
* @param e the element to add |
236 |
> |
* @return <tt>true</tt> (as specified by {@link Deque#offerLast}) |
237 |
> |
* @throws NullPointerException if the specified element is null |
238 |
|
*/ |
239 |
|
public boolean offerLast(E e) { |
240 |
|
addLast(e); |
242 |
|
} |
243 |
|
|
244 |
|
/** |
245 |
< |
* Retrieves and removes the first element of this deque. This method |
277 |
< |
* differs from the <tt>pollFirst</tt> method in that it throws an |
278 |
< |
* exception if this deque is empty. |
279 |
< |
* |
280 |
< |
* @return the first element of this deque |
281 |
< |
* @throws NoSuchElementException if this deque is empty |
245 |
> |
* @throws NoSuchElementException {@inheritDoc} |
246 |
|
*/ |
247 |
|
public E removeFirst() { |
248 |
|
E x = pollFirst(); |
252 |
|
} |
253 |
|
|
254 |
|
/** |
255 |
< |
* Retrieves and removes the last element of this deque. This method |
292 |
< |
* differs from the <tt>pollLast</tt> method in that it throws an |
293 |
< |
* exception if this deque is empty. |
294 |
< |
* |
295 |
< |
* @return the last element of this deque |
296 |
< |
* @throws NoSuchElementException if this deque is empty |
255 |
> |
* @throws NoSuchElementException {@inheritDoc} |
256 |
|
*/ |
257 |
|
public E removeLast() { |
258 |
|
E x = pollLast(); |
261 |
|
return x; |
262 |
|
} |
263 |
|
|
264 |
< |
/** |
265 |
< |
* Retrieves, but does not remove, the first element of this deque, |
266 |
< |
* returning <tt>null</tt> if this deque is empty. |
267 |
< |
* |
268 |
< |
* @return the first element of this deque, or <tt>null</tt> if |
269 |
< |
* this deque is empty |
270 |
< |
*/ |
271 |
< |
public E peekFirst() { |
313 |
< |
return elements[head]; // elements[head] is null if deque empty |
264 |
> |
public E pollFirst() { |
265 |
> |
int h = head; |
266 |
> |
E result = elements[h]; // Element is null if deque empty |
267 |
> |
if (result == null) |
268 |
> |
return null; |
269 |
> |
elements[h] = null; // Must null out slot |
270 |
> |
head = (h + 1) & (elements.length - 1); |
271 |
> |
return result; |
272 |
|
} |
273 |
|
|
274 |
< |
/** |
275 |
< |
* Retrieves, but does not remove, the last element of this deque, |
276 |
< |
* returning <tt>null</tt> if this deque is empty. |
277 |
< |
* |
278 |
< |
* @return the last element of this deque, or <tt>null</tt> if this deque |
279 |
< |
* is empty |
280 |
< |
*/ |
281 |
< |
public E peekLast() { |
324 |
< |
return elements[(tail - 1) & (elements.length - 1)]; |
274 |
> |
public E pollLast() { |
275 |
> |
int t = (tail - 1) & (elements.length - 1); |
276 |
> |
E result = elements[t]; |
277 |
> |
if (result == null) |
278 |
> |
return null; |
279 |
> |
elements[t] = null; |
280 |
> |
tail = t; |
281 |
> |
return result; |
282 |
|
} |
283 |
|
|
284 |
|
/** |
285 |
< |
* Retrieves, but does not remove, the first element of this |
329 |
< |
* deque. This method differs from the <tt>peekFirst</tt> method only |
330 |
< |
* in that it throws an exception if this deque is empty. |
331 |
< |
* |
332 |
< |
* @return the first element of this deque |
333 |
< |
* @throws NoSuchElementException if this deque is empty |
285 |
> |
* @throws NoSuchElementException {@inheritDoc} |
286 |
|
*/ |
287 |
|
public E getFirst() { |
288 |
|
E x = elements[head]; |
292 |
|
} |
293 |
|
|
294 |
|
/** |
295 |
< |
* Retrieves, but does not remove, the last element of this |
344 |
< |
* deque. This method differs from the <tt>peekLast</tt> method only |
345 |
< |
* in that it throws an exception if this deque is empty. |
346 |
< |
* |
347 |
< |
* @return the last element of this deque |
348 |
< |
* @throws NoSuchElementException if this deque is empty |
295 |
> |
* @throws NoSuchElementException {@inheritDoc} |
296 |
|
*/ |
297 |
|
public E getLast() { |
298 |
|
E x = elements[(tail - 1) & (elements.length - 1)]; |
301 |
|
return x; |
302 |
|
} |
303 |
|
|
304 |
+ |
public E peekFirst() { |
305 |
+ |
return elements[head]; // elements[head] is null if deque empty |
306 |
+ |
} |
307 |
+ |
|
308 |
+ |
public E peekLast() { |
309 |
+ |
return elements[(tail - 1) & (elements.length - 1)]; |
310 |
+ |
} |
311 |
+ |
|
312 |
|
/** |
313 |
|
* Removes the first occurrence of the specified element in this |
314 |
< |
* deque (when traversing the deque from head to tail). More |
315 |
< |
* formally, removes the first element e such that (o==null ? |
316 |
< |
* e==null : o.equals(e)). If the deque does not contain the |
317 |
< |
* element, it is unchanged. |
314 |
> |
* deque (when traversing the deque from head to tail). |
315 |
> |
* If the deque does not contain the element, it is unchanged. |
316 |
> |
* More formally, removes the first element <tt>e</tt> such that |
317 |
> |
* <tt>o.equals(e)</tt> (if such an element exists). |
318 |
> |
* Returns <tt>true</tt> if this deque contained the specified element |
319 |
> |
* (or equivalently, if this deque changed as a result of the call). |
320 |
|
* |
321 |
|
* @param o element to be removed from this deque, if present |
322 |
|
* @return <tt>true</tt> if the deque contained the specified element |
339 |
|
|
340 |
|
/** |
341 |
|
* Removes the last occurrence of the specified element in this |
342 |
< |
* deque (when traversing the deque from head to tail). More |
343 |
< |
* formally, removes the last element e such that (o==null ? |
344 |
< |
* e==null : o.equals(e)). If the deque |
345 |
< |
* does not contain the element, it is unchanged. |
342 |
> |
* deque (when traversing the deque from head to tail). |
343 |
> |
* If the deque does not contain the element, it is unchanged. |
344 |
> |
* More formally, removes the last element <tt>e</tt> such that |
345 |
> |
* <tt>o.equals(e)</tt> (if such an element exists). |
346 |
> |
* Returns <tt>true</tt> if this deque contained the specified element |
347 |
> |
* (or equivalently, if this deque changed as a result of the call). |
348 |
|
* |
349 |
|
* @param o element to be removed from this deque, if present |
350 |
|
* @return <tt>true</tt> if the deque contained the specified element |
370 |
|
/** |
371 |
|
* Inserts the specified element at the end of this deque. |
372 |
|
* |
414 |
– |
* <p>This method is equivalent to {@link #offerLast}. |
415 |
– |
* |
416 |
– |
* @param e the element to insert |
417 |
– |
* @return <tt>true</tt> (as per the spec for {@link Queue#offer}) |
418 |
– |
* @throws NullPointerException if <tt>e</tt> is null |
419 |
– |
*/ |
420 |
– |
public boolean offer(E e) { |
421 |
– |
return offerLast(e); |
422 |
– |
} |
423 |
– |
|
424 |
– |
/** |
425 |
– |
* Inserts the specified element at the end of this deque. |
426 |
– |
* |
373 |
|
* <p>This method is equivalent to {@link #addLast}. |
374 |
|
* |
375 |
< |
* @param e the element to insert |
376 |
< |
* @return <tt>true</tt> (as per the spec for {@link Collection#add}) |
377 |
< |
* @throws NullPointerException if <tt>e</tt> is null |
375 |
> |
* @param e the element to add |
376 |
> |
* @return <tt>true</tt> (as specified by {@link Collection#add}) |
377 |
> |
* @throws NullPointerException if the specified element is null |
378 |
|
*/ |
379 |
|
public boolean add(E e) { |
380 |
|
addLast(e); |
382 |
|
} |
383 |
|
|
384 |
|
/** |
385 |
< |
* Retrieves and removes the head of the queue represented by |
440 |
< |
* this deque, or <tt>null</tt> if this deque is empty. In other words, |
441 |
< |
* retrieves and removes the first element of this deque, or <tt>null</tt> |
442 |
< |
* if this deque is empty. |
385 |
> |
* Inserts the specified element at the end of this deque. |
386 |
|
* |
387 |
< |
* <p>This method is equivalent to {@link #pollFirst}. |
387 |
> |
* <p>This method is equivalent to {@link #offerLast}. |
388 |
|
* |
389 |
< |
* @return the first element of this deque, or <tt>null</tt> if |
390 |
< |
* this deque is empty |
389 |
> |
* @param e the element to add |
390 |
> |
* @return <tt>true</tt> (as specified by {@link Queue#offer}) |
391 |
> |
* @throws NullPointerException if the specified element is null |
392 |
|
*/ |
393 |
< |
public E poll() { |
394 |
< |
return pollFirst(); |
393 |
> |
public boolean offer(E e) { |
394 |
> |
return offerLast(e); |
395 |
|
} |
396 |
|
|
397 |
|
/** |
398 |
|
* Retrieves and removes the head of the queue represented by this deque. |
399 |
< |
* This method differs from the <tt>poll</tt> method in that it throws an |
399 |
> |
* |
400 |
> |
* This method differs from {@link #poll poll} only in that it throws an |
401 |
|
* exception if this deque is empty. |
402 |
|
* |
403 |
|
* <p>This method is equivalent to {@link #removeFirst}. |
404 |
|
* |
405 |
|
* @return the head of the queue represented by this deque |
406 |
< |
* @throws NoSuchElementException if this deque is empty |
406 |
> |
* @throws NoSuchElementException {@inheritDoc} |
407 |
|
*/ |
408 |
|
public E remove() { |
409 |
|
return removeFirst(); |
410 |
|
} |
411 |
|
|
412 |
|
/** |
413 |
< |
* Retrieves, but does not remove, the head of the queue represented by |
414 |
< |
* this deque, returning <tt>null</tt> if this deque is empty. |
413 |
> |
* Retrieves and removes the head of the queue represented by this deque |
414 |
> |
* (in other words, the first element of this deque), or returns |
415 |
> |
* <tt>null</tt> if this deque is empty. |
416 |
|
* |
417 |
< |
* <p>This method is equivalent to {@link #peekFirst} |
417 |
> |
* <p>This method is equivalent to {@link #pollFirst}. |
418 |
|
* |
419 |
|
* @return the head of the queue represented by this deque, or |
420 |
< |
* <tt>null</tt> if this deque is empty |
420 |
> |
* <tt>null</tt> if this deque is empty |
421 |
|
*/ |
422 |
< |
public E peek() { |
423 |
< |
return peekFirst(); |
422 |
> |
public E poll() { |
423 |
> |
return pollFirst(); |
424 |
|
} |
425 |
|
|
426 |
|
/** |
427 |
|
* Retrieves, but does not remove, the head of the queue represented by |
428 |
< |
* this deque. This method differs from the <tt>peek</tt> method only in |
428 |
> |
* this deque. This method differs from {@link #peek peek} only in |
429 |
|
* that it throws an exception if this deque is empty. |
430 |
|
* |
431 |
< |
* <p>This method is equivalent to {@link #getFirst} |
431 |
> |
* <p>This method is equivalent to {@link #getFirst}. |
432 |
|
* |
433 |
|
* @return the head of the queue represented by this deque |
434 |
< |
* @throws NoSuchElementException if this deque is empty |
434 |
> |
* @throws NoSuchElementException {@inheritDoc} |
435 |
|
*/ |
436 |
|
public E element() { |
437 |
|
return getFirst(); |
438 |
|
} |
439 |
|
|
440 |
+ |
/** |
441 |
+ |
* Retrieves, but does not remove, the head of the queue represented by |
442 |
+ |
* this deque, or returns <tt>null</tt> if this deque is empty. |
443 |
+ |
* |
444 |
+ |
* <p>This method is equivalent to {@link #peekFirst}. |
445 |
+ |
* |
446 |
+ |
* @return the head of the queue represented by this deque, or |
447 |
+ |
* <tt>null</tt> if this deque is empty |
448 |
+ |
*/ |
449 |
+ |
public E peek() { |
450 |
+ |
return peekFirst(); |
451 |
+ |
} |
452 |
+ |
|
453 |
|
// *** Stack methods *** |
454 |
|
|
455 |
|
/** |
459 |
|
* <p>This method is equivalent to {@link #addFirst}. |
460 |
|
* |
461 |
|
* @param e the element to push |
462 |
< |
* @throws NullPointerException if <tt>e</tt> is null |
462 |
> |
* @throws NullPointerException if the specified element is null |
463 |
|
*/ |
464 |
|
public void push(E e) { |
465 |
|
addFirst(e); |
472 |
|
* <p>This method is equivalent to {@link #removeFirst()}. |
473 |
|
* |
474 |
|
* @return the element at the front of this deque (which is the top |
475 |
< |
* of the stack represented by this deque) |
476 |
< |
* @throws NoSuchElementException if this deque is empty |
475 |
> |
* of the stack represented by this deque) |
476 |
> |
* @throws NoSuchElementException {@inheritDoc} |
477 |
|
*/ |
478 |
|
public E pop() { |
479 |
|
return removeFirst(); |
481 |
|
|
482 |
|
/** |
483 |
|
* Removes the element at the specified position in the elements array, |
484 |
< |
* adjusting head, tail, and size as necessary. This can result in |
485 |
< |
* motion of elements backwards or forwards in the array. |
484 |
> |
* adjusting head and tail as necessary. This can result in motion of |
485 |
> |
* elements backwards or forwards in the array. |
486 |
|
* |
487 |
|
* <p>This method is called delete rather than remove to emphasize |
488 |
< |
* that its semantics differ from those of List.remove(int). |
488 |
> |
* that its semantics differ from those of {@link List#remove(int)}. |
489 |
|
* |
490 |
|
* @return true if elements moved backwards |
491 |
|
*/ |
492 |
|
private boolean delete(int i) { |
493 |
+ |
int mask = elements.length - 1; |
494 |
+ |
|
495 |
+ |
// Invariant: head <= i < tail mod circularity |
496 |
+ |
if (((i - head) & mask) >= ((tail - head) & mask)) |
497 |
+ |
throw new ConcurrentModificationException(); |
498 |
+ |
|
499 |
|
// Case 1: Deque doesn't wrap |
500 |
|
// Case 2: Deque does wrap and removed element is in the head portion |
501 |
< |
if ((head < tail || tail == 0) || i >= head) { |
501 |
> |
if (i >= head) { |
502 |
|
System.arraycopy(elements, head, elements, head + 1, i - head); |
503 |
|
elements[head] = null; |
504 |
< |
head = (head + 1) & (elements.length - 1); |
504 |
> |
head = (head + 1) & mask; |
505 |
|
return false; |
506 |
|
} |
507 |
|
|
524 |
|
} |
525 |
|
|
526 |
|
/** |
527 |
< |
* Returns <tt>true</tt> if this deque contains no elements.<p> |
527 |
> |
* Returns <tt>true</tt> if this deque contains no elements. |
528 |
|
* |
529 |
< |
* @return <tt>true</tt> if this deque contains no elements. |
529 |
> |
* @return <tt>true</tt> if this deque contains no elements |
530 |
|
*/ |
531 |
|
public boolean isEmpty() { |
532 |
|
return head == tail; |
590 |
|
} |
591 |
|
|
592 |
|
/** |
593 |
< |
* Returns <tt>true</tt> if this deque contains the specified |
594 |
< |
* element. More formally, returns <tt>true</tt> if and only if this |
595 |
< |
* deque contains at least one element <tt>e</tt> such that |
631 |
< |
* <tt>e.equals(o)</tt>. |
593 |
> |
* Returns <tt>true</tt> if this deque contains the specified element. |
594 |
> |
* More formally, returns <tt>true</tt> if and only if this deque contains |
595 |
> |
* at least one element <tt>e</tt> such that <tt>o.equals(e)</tt>. |
596 |
|
* |
597 |
|
* @param o object to be checked for containment in this deque |
598 |
|
* @return <tt>true</tt> if this deque contains the specified element |
613 |
|
|
614 |
|
/** |
615 |
|
* Removes a single instance of the specified element from this deque. |
616 |
< |
* This method is equivalent to {@link #removeFirstOccurrence}. |
616 |
> |
* If the deque does not contain the element, it is unchanged. |
617 |
> |
* More formally, removes the first element <tt>e</tt> such that |
618 |
> |
* <tt>o.equals(e)</tt> (if such an element exists). |
619 |
> |
* Returns <tt>true</tt> if this deque contained the specified element |
620 |
> |
* (or equivalently, if this deque changed as a result of the call). |
621 |
|
* |
622 |
< |
* @param e element to be removed from this deque, if present |
622 |
> |
* <p>This method is equivalent to {@link #removeFirstOccurrence}. |
623 |
> |
* |
624 |
> |
* @param o element to be removed from this deque, if present |
625 |
|
* @return <tt>true</tt> if this deque contained the specified element |
626 |
|
*/ |
627 |
< |
public boolean remove(Object e) { |
628 |
< |
return removeFirstOccurrence(e); |
627 |
> |
public boolean remove(Object o) { |
628 |
> |
return removeFirstOccurrence(o); |
629 |
|
} |
630 |
|
|
631 |
|
/** |
642 |
|
do { |
643 |
|
elements[i] = null; |
644 |
|
i = (i + 1) & mask; |
645 |
< |
} while(i != t); |
645 |
> |
} while (i != t); |
646 |
|
} |
647 |
|
} |
648 |
|
|
649 |
|
/** |
650 |
|
* Returns an array containing all of the elements in this deque |
651 |
< |
* in the correct order. |
651 |
> |
* in proper sequence (from first to last element). |
652 |
> |
* |
653 |
> |
* <p>The returned array will be "safe" in that no references to it are |
654 |
> |
* maintained by this deque. (In other words, this method must allocate |
655 |
> |
* a new array). The caller is thus free to modify the returned array. |
656 |
> |
* |
657 |
> |
* <p>This method acts as bridge between array-based and collection-based |
658 |
> |
* APIs. |
659 |
|
* |
660 |
|
* @return an array containing all of the elements in this deque |
684 |
– |
* in the correct order |
661 |
|
*/ |
662 |
|
public Object[] toArray() { |
663 |
|
return copyElements(new Object[size()]); |
664 |
|
} |
665 |
|
|
666 |
|
/** |
667 |
< |
* Returns an array containing all of the elements in this deque in the |
668 |
< |
* correct order; the runtime type of the returned array is that of the |
669 |
< |
* specified array. If the deque fits in the specified array, it is |
670 |
< |
* returned therein. Otherwise, a new array is allocated with the runtime |
671 |
< |
* type of the specified array and the size of this deque. |
672 |
< |
* |
673 |
< |
* <p>If the deque fits in the specified array with room to spare (i.e., |
674 |
< |
* the array has more elements than the deque), the element in the array |
675 |
< |
* immediately following the end of the collection is set to <tt>null</tt>. |
667 |
> |
* Returns an array containing all of the elements in this deque in |
668 |
> |
* proper sequence (from first to last element); the runtime type of the |
669 |
> |
* returned array is that of the specified array. If the deque fits in |
670 |
> |
* the specified array, it is returned therein. Otherwise, a new array |
671 |
> |
* is allocated with the runtime type of the specified array and the |
672 |
> |
* size of this deque. |
673 |
> |
* |
674 |
> |
* <p>If this deque fits in the specified array with room to spare |
675 |
> |
* (i.e., the array has more elements than this deque), the element in |
676 |
> |
* the array immediately following the end of the deque is set to |
677 |
> |
* <tt>null</tt>. |
678 |
> |
* |
679 |
> |
* <p>Like the {@link #toArray()} method, this method acts as bridge between |
680 |
> |
* array-based and collection-based APIs. Further, this method allows |
681 |
> |
* precise control over the runtime type of the output array, and may, |
682 |
> |
* under certain circumstances, be used to save allocation costs. |
683 |
> |
* |
684 |
> |
* <p>Suppose <tt>x</tt> is a deque known to contain only strings. |
685 |
> |
* The following code can be used to dump the deque into a newly |
686 |
> |
* allocated array of <tt>String</tt>: |
687 |
> |
* |
688 |
> |
* <pre> |
689 |
> |
* String[] y = x.toArray(new String[0]);</pre> |
690 |
> |
* |
691 |
> |
* Note that <tt>toArray(new Object[0])</tt> is identical in function to |
692 |
> |
* <tt>toArray()</tt>. |
693 |
|
* |
694 |
|
* @param a the array into which the elements of the deque are to |
695 |
< |
* be stored, if it is big enough; otherwise, a new array of the |
696 |
< |
* same runtime type is allocated for this purpose |
697 |
< |
* @return an array containing the elements of the deque |
698 |
< |
* @throws ArrayStoreException if the runtime type of a is not a supertype |
699 |
< |
* of the runtime type of every element in this deque |
695 |
> |
* be stored, if it is big enough; otherwise, a new array of the |
696 |
> |
* same runtime type is allocated for this purpose |
697 |
> |
* @return an array containing all of the elements in this deque |
698 |
> |
* @throws ArrayStoreException if the runtime type of the specified array |
699 |
> |
* is not a supertype of the runtime type of every element in |
700 |
> |
* this deque |
701 |
> |
* @throws NullPointerException if the specified array is null |
702 |
|
*/ |
703 |
|
public <T> T[] toArray(T[] a) { |
704 |
|
int size = size(); |