ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/main/java/util/ArrayDeque.java
(Generate patch)

Comparing jsr166/src/main/java/util/ArrayDeque.java (file contents):
Revision 1.6 by dl, Tue Mar 22 16:48:32 2005 UTC vs.
Revision 1.19 by dl, Fri Sep 16 11:15:41 2005 UTC

# Line 4 | Line 4
4   */
5  
6   package java.util;
7 + import java.util.*; // for javadoc (till 6280605 is fixed)
8   import java.io.*;
9  
10   /**
# Line 18 | Line 19 | import java.io.*;
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   *
26   * <p>The iterators returned by this class's <tt>iterator</tt> method are
27   * <i>fail-fast</i>: If the deque is modified at any time after the iterator
28 < * is created, in any way except through the iterator's own remove method, the
29 < * iterator will generally throw a {@link ConcurrentModificationException}.
30 < * Thus, in the face of concurrent modification, the iterator fails quickly
31 < * and cleanly, rather than risking arbitrary, non-deterministic behavior at
32 < * an undetermined time in the future.
28 > * is created, in any way except through the iterator's own <tt>remove</tt>
29 > * method, the iterator will generally throw a {@link
30 > * ConcurrentModificationException}.  Thus, in the face of concurrent
31 > * modification, the iterator fails quickly and cleanly, rather than risking
32 > * arbitrary, non-deterministic behavior at an undetermined time in the
33 > * future.
34   *
35   * <p>Note that the fail-fast behavior of an iterator cannot be guaranteed
36   * as it is, generally speaking, impossible to make any hard guarantees in the
# Line 39 | Line 41 | import java.io.*;
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
# Line 87 | Line 91 | public class ArrayDeque<E> extends Abstr
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;
# Line 129 | Line 133 | public class ArrayDeque<E> extends Abstr
133      }
134  
135      /**
136 <     * Copy the elements from our element array into the specified array,
136 >     * Copies the elements from our element array into the specified array,
137       * in order (from first to last element in the deque).  It is assumed
138       * that the array is large enough to hold all elements in the deque.
139       *
# Line 186 | Line 190 | public class ArrayDeque<E> extends Abstr
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)
# Line 199 | Line 203 | public class ArrayDeque<E> extends Abstr
203  
204      /**
205       * Inserts the specified element at the end of this deque.
202     * This method is equivalent to {@link Collection#add} and
203     * {@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)
# Line 214 | Line 218 | public class ArrayDeque<E> extends Abstr
218      }
219  
220      /**
217     * Retrieves and removes the first element of this deque, or
218     * <tt>null</tt> if this deque is empty.
219     *
220     * @return the first element of this deque, or <tt>null</tt> if
221     *     this deque is empty
222     */
223    public E pollFirst() {
224        int h = head;
225        E result = elements[h]; // Element is null if deque empty
226        if (result == null)
227            return null;
228        elements[h] = null;     // Must null out slot
229        head = (h + 1) & (elements.length - 1);
230        return result;
231    }
232
233    /**
234     * Retrieves and removes the last element of this deque, or
235     * <tt>null</tt> if this deque is empty.
236     *
237     * @return the last element of this deque, or <tt>null</tt> if
238     *     this deque is empty
239     */
240    public E pollLast() {
241        int t = (tail - 1) & (elements.length - 1);
242        E result = elements[t];
243        if (result == null)
244            return null;
245        elements[t] = null;
246        tail = t;
247        return result;
248    }
249
250    /**
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);
# Line 262 | Line 232 | public class ArrayDeque<E> extends Abstr
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);
# Line 272 | Line 242 | public class ArrayDeque<E> extends Abstr
242      }
243  
244      /**
245 <     * Retrieves and removes the first element of this deque.  This method
276 <     * differs from the <tt>pollFirst</tt> method in that it throws an
277 <     * exception if this deque is empty.
278 <     *
279 <     * @return the first element of this deque
280 <     * @throws NoSuchElementException if this deque is empty
245 >     * @throws NoSuchElementException {@inheritDoc}
246       */
247      public E removeFirst() {
248          E x = pollFirst();
# Line 287 | Line 252 | public class ArrayDeque<E> extends Abstr
252      }
253  
254      /**
255 <     * Retrieves and removes the last element of this deque.  This method
291 <     * differs from the <tt>pollLast</tt> method in that it throws an
292 <     * exception if this deque is empty.
293 <     *
294 <     * @return the last element of this deque
295 <     * @throws NoSuchElementException if this deque is empty
255 >     * @throws NoSuchElementException {@inheritDoc}
256       */
257      public E removeLast() {
258          E x = pollLast();
# Line 301 | Line 261 | public class ArrayDeque<E> extends Abstr
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() {
312 <        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() {
323 <        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
328 <     * deque.  This method differs from the <tt>peekFirst</tt> method only
329 <     * in that it throws an exception if this deque is empty.
330 <     *
331 <     * @return the first element of this deque
332 <     * @throws NoSuchElementException if this deque is empty
285 >     * @throws NoSuchElementException {@inheritDoc}
286       */
287      public E getFirst() {
288          E x = elements[head];
# Line 339 | Line 292 | public class ArrayDeque<E> extends Abstr
292      }
293  
294      /**
295 <     * Retrieves, but does not remove, the last element of this
343 <     * deque.  This method differs from the <tt>peekLast</tt> method only
344 <     * in that it throws an exception if this deque is empty.
345 <     *
346 <     * @return the last element of this deque
347 <     * @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)];
# Line 353 | Line 301 | public class ArrayDeque<E> extends Abstr
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
# Line 381 | Line 339 | public class ArrayDeque<E> extends Abstr
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
# Line 410 | Line 370 | public class ArrayDeque<E> extends Abstr
370      /**
371       * Inserts the specified element at the end of this deque.
372       *
413     * <p>This method is equivalent to {@link #offerLast}.
414     *
415     * @param e the element to insert
416     * @return <tt>true</tt> (as per the spec for {@link Queue#offer})
417     * @throws NullPointerException if <tt>e</tt> is null
418     */
419    public boolean offer(E e) {
420        return offerLast(e);
421    }
422
423    /**
424     * Inserts the specified element at the end of this deque.
425     *
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);
# Line 435 | Line 382 | public class ArrayDeque<E> extends Abstr
382      }
383  
384      /**
385 <     * Retrieves and removes the head of the queue represented by
439 <     * this deque, or <tt>null</tt> if this deque is empty.  In other words,
440 <     * retrieves and removes the first element of this deque, or <tt>null</tt>
441 <     * 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      /**
# Line 499 | Line 459 | public class ArrayDeque<E> extends Abstr
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);
# Line 512 | Line 472 | public class ArrayDeque<E> extends Abstr
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();
480      }
481  
482      /**
483 <     * Remove 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.
483 >     * Removes the element at the specified position in the elements 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  
# Line 558 | Line 524 | public class ArrayDeque<E> extends Abstr
524      }
525  
526      /**
527 <     * Returns <tt>true</tt> if this collection contains no elements.<p>
527 >     * Returns <tt>true</tt> if this deque contains no elements.
528       *
529 <     * @return <tt>true</tt> if this collection contains no elements.
529 >     * @return <tt>true</tt> if this deque contains no elements
530       */
531      public boolean isEmpty() {
532          return head == tail;
# Line 572 | Line 538 | public class ArrayDeque<E> extends Abstr
538       * order that elements would be dequeued (via successive calls to
539       * {@link #remove} or popped (via successive calls to {@link #pop}).
540       *
541 <     * @return an <tt>Iterator</tt> over the elements in this deque
541 >     * @return an iterator over the elements in this deque
542       */
543      public Iterator<E> iterator() {
544          return new DeqIterator();
545      }
546  
547 +    public Iterator<E> descendingIterator() {
548 +        return new DescendingIterator();
549 +    }
550 +
551      private class DeqIterator implements Iterator<E> {
552          /**
553           * Index of element to be returned by subsequent call to next.
# Line 616 | Line 586 | public class ArrayDeque<E> extends Abstr
586          public void remove() {
587              if (lastRet < 0)
588                  throw new IllegalStateException();
589 <            if (delete(lastRet))
590 <                cursor--;
589 >            if (delete(lastRet)) // if left-shifted, undo increment in next()
590 >                cursor = (cursor - 1) & (elements.length - 1);
591              lastRet = -1;
592              fence = tail;
593          }
594      }
595  
596 +
597 +    private class DescendingIterator implements Iterator<E> {
598 +        /*
599 +         * This class is nearly a mirror-image of DeqIterator, using
600 +         * (tail-1) instead of head for initial cursor, (head-1)
601 +         * instead of tail for fence, and elements.length instead of -1
602 +         * for sentinel. It shares the same structure, but not many
603 +         * actual lines of code.
604 +         */
605 +        private int cursor = (tail - 1) & (elements.length - 1);
606 +        private int fence =  (head - 1) & (elements.length - 1);
607 +        private int lastRet = elements.length;
608 +
609 +        public boolean hasNext() {
610 +            return cursor != fence;
611 +        }
612 +
613 +        public E next() {
614 +            E result;
615 +            if (cursor == fence)
616 +                throw new NoSuchElementException();
617 +            if (((head - 1) & (elements.length - 1)) != fence ||
618 +                (result = elements[cursor]) == null)
619 +                throw new ConcurrentModificationException();
620 +            lastRet = cursor;
621 +            cursor = (cursor - 1) & (elements.length - 1);
622 +            return result;
623 +        }
624 +
625 +        public void remove() {
626 +            if (lastRet >= elements.length)
627 +                throw new IllegalStateException();
628 +            if (!delete(lastRet))
629 +                cursor = (cursor + 1) & (elements.length - 1);
630 +            lastRet = elements.length;
631 +            fence = (head - 1) & (elements.length - 1);
632 +        }
633 +    }
634 +
635      /**
636 <     * Returns <tt>true</tt> if this deque contains the specified
637 <     * element.  More formally, returns <tt>true</tt> if and only if this
638 <     * deque contains at least one element <tt>e</tt> such that
630 <     * <tt>e.equals(o)</tt>.
636 >     * Returns <tt>true</tt> if this deque contains the specified element.
637 >     * More formally, returns <tt>true</tt> if and only if this deque contains
638 >     * at least one element <tt>e</tt> such that <tt>o.equals(e)</tt>.
639       *
640       * @param o object to be checked for containment in this deque
641       * @return <tt>true</tt> if this deque contains the specified element
# Line 648 | Line 656 | public class ArrayDeque<E> extends Abstr
656  
657      /**
658       * Removes a single instance of the specified element from this deque.
659 <     * This method is equivalent to {@link #removeFirstOccurrence}.
659 >     * If the deque does not contain the element, it is unchanged.
660 >     * More formally, removes the first element <tt>e</tt> such that
661 >     * <tt>o.equals(e)</tt> (if such an element exists).
662 >     * Returns <tt>true</tt> if this deque contained the specified element
663 >     * (or equivalently, if this deque changed as a result of the call).
664 >     *
665 >     * <p>This method is equivalent to {@link #removeFirstOccurrence}.
666       *
667 <     * @param e element to be removed from this deque, if present
667 >     * @param o element to be removed from this deque, if present
668       * @return <tt>true</tt> if this deque contained the specified element
669       */
670 <    public boolean remove(Object e) {
671 <        return removeFirstOccurrence(e);
670 >    public boolean remove(Object o) {
671 >        return removeFirstOccurrence(o);
672      }
673  
674      /**
675       * Removes all of the elements from this deque.
676 +     * The deque will be empty after this call returns.
677       */
678      public void clear() {
679          int h = head;
# Line 670 | Line 685 | public class ArrayDeque<E> extends Abstr
685              do {
686                  elements[i] = null;
687                  i = (i + 1) & mask;
688 <            } while(i != t);
688 >            } while (i != t);
689          }
690      }
691  
692      /**
693       * Returns an array containing all of the elements in this deque
694 <     * in the correct order.
694 >     * in proper sequence (from first to last element).
695 >     *
696 >     * <p>The returned array will be "safe" in that no references to it are
697 >     * maintained by this deque.  (In other words, this method must allocate
698 >     * a new array).  The caller is thus free to modify the returned array.
699 >     *
700 >     * <p>This method acts as bridge between array-based and collection-based
701 >     * APIs.
702       *
703       * @return an array containing all of the elements in this deque
682     *         in the correct order
704       */
705      public Object[] toArray() {
706          return copyElements(new Object[size()]);
707      }
708  
709      /**
710 <     * Returns an array containing all of the elements in this deque in the
711 <     * correct order; the runtime type of the returned array is that of the
712 <     * specified array.  If the deque fits in the specified array, it is
713 <     * returned therein.  Otherwise, a new array is allocated with the runtime
714 <     * type of the specified array and the size of this deque.
715 <     *
716 <     * <p>If the deque fits in the specified array with room to spare (i.e.,
717 <     * the array has more elements than the deque), the element in the array
718 <     * immediately following the end of the collection is set to <tt>null</tt>.
710 >     * Returns an array containing all of the elements in this deque in
711 >     * proper sequence (from first to last element); the runtime type of the
712 >     * returned array is that of the specified array.  If the deque fits in
713 >     * the specified array, it is returned therein.  Otherwise, a new array
714 >     * is allocated with the runtime type of the specified array and the
715 >     * size of this deque.
716 >     *
717 >     * <p>If this deque fits in the specified array with room to spare
718 >     * (i.e., the array has more elements than this deque), the element in
719 >     * the array immediately following the end of the deque is set to
720 >     * <tt>null</tt>.
721 >     *
722 >     * <p>Like the {@link #toArray()} method, this method acts as bridge between
723 >     * array-based and collection-based APIs.  Further, this method allows
724 >     * precise control over the runtime type of the output array, and may,
725 >     * under certain circumstances, be used to save allocation costs.
726 >     *
727 >     * <p>Suppose <tt>x</tt> is a deque known to contain only strings.
728 >     * The following code can be used to dump the deque into a newly
729 >     * allocated array of <tt>String</tt>:
730 >     *
731 >     * <pre>
732 >     *     String[] y = x.toArray(new String[0]);</pre>
733 >     *
734 >     * Note that <tt>toArray(new Object[0])</tt> is identical in function to
735 >     * <tt>toArray()</tt>.
736       *
737       * @param a the array into which the elements of the deque are to
738 <     *          be stored, if it is big enough; otherwise, a new array of the
739 <     *          same runtime type is allocated for this purpose
740 <     * @return an array containing the elements of the deque
741 <     * @throws ArrayStoreException if the runtime type of a is not a supertype
742 <     *         of the runtime type of every element in this deque
738 >     *          be stored, if it is big enough; otherwise, a new array of the
739 >     *          same runtime type is allocated for this purpose
740 >     * @return an array containing all of the elements in this deque
741 >     * @throws ArrayStoreException if the runtime type of the specified array
742 >     *         is not a supertype of the runtime type of every element in
743 >     *         this deque
744 >     * @throws NullPointerException if the specified array is null
745       */
746      public <T> T[] toArray(T[] a) {
747          int size = size();
# Line 750 | Line 790 | public class ArrayDeque<E> extends Abstr
790          s.defaultWriteObject();
791  
792          // Write out size
793 <        int size = size();
754 <        s.writeInt(size);
793 >        s.writeInt(size());
794  
795          // Write out elements in order.
757        int i = head;
796          int mask = elements.length - 1;
797 <        for (int j = 0; j < size; j++) {
797 >        for (int i = head; i != tail; i = (i + 1) & mask)
798              s.writeObject(elements[i]);
761            i = (i + 1) & mask;
762        }
799      }
800  
801      /**

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines