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

Comparing jsr166/src/main/java/util/Deque.java (file contents):
Revision 1.24 by jsr166, Mon Feb 11 17:27:45 2013 UTC vs.
Revision 1.33 by jsr166, Wed Sep 30 00:03:02 2015 UTC

# Line 27 | Line 27 | package java.util;
27   * <p>The twelve methods described above are summarized in the
28   * following table:
29   *
30 – * <p>
30   * <table BORDER CELLPADDING=3 CELLSPACING=1>
31   * <caption>Summary of Deque methods</caption>
32   *  <tr>
# Line 44 | Line 43 | package java.util;
43   *  </tr>
44   *  <tr>
45   *    <td><b>Insert</b></td>
46 < *    <td>{@link #addFirst addFirst(e)}</td>
47 < *    <td>{@link #offerFirst offerFirst(e)}</td>
48 < *    <td>{@link #addLast addLast(e)}</td>
49 < *    <td>{@link #offerLast offerLast(e)}</td>
46 > *    <td>{@link Deque#addFirst addFirst(e)}</td>
47 > *    <td>{@link Deque#offerFirst offerFirst(e)}</td>
48 > *    <td>{@link Deque#addLast addLast(e)}</td>
49 > *    <td>{@link Deque#offerLast offerLast(e)}</td>
50   *  </tr>
51   *  <tr>
52   *    <td><b>Remove</b></td>
53 < *    <td>{@link #removeFirst removeFirst()}</td>
54 < *    <td>{@link #pollFirst pollFirst()}</td>
55 < *    <td>{@link #removeLast removeLast()}</td>
56 < *    <td>{@link #pollLast pollLast()}</td>
53 > *    <td>{@link Deque#removeFirst removeFirst()}</td>
54 > *    <td>{@link Deque#pollFirst pollFirst()}</td>
55 > *    <td>{@link Deque#removeLast removeLast()}</td>
56 > *    <td>{@link Deque#pollLast pollLast()}</td>
57   *  </tr>
58   *  <tr>
59   *    <td><b>Examine</b></td>
60 < *    <td>{@link #getFirst getFirst()}</td>
61 < *    <td>{@link #peekFirst peekFirst()}</td>
62 < *    <td>{@link #getLast getLast()}</td>
63 < *    <td>{@link #peekLast peekLast()}</td>
60 > *    <td>{@link Deque#getFirst getFirst()}</td>
61 > *    <td>{@link Deque#peekFirst peekFirst()}</td>
62 > *    <td>{@link Deque#getLast getLast()}</td>
63 > *    <td>{@link Deque#peekLast peekLast()}</td>
64   *  </tr>
65   * </table>
66   *
# Line 71 | Line 70 | package java.util;
70   * inherited from the {@code Queue} interface are precisely equivalent to
71   * {@code Deque} methods as indicated in the following table:
72   *
74 – * <p>
73   * <table BORDER CELLPADDING=3 CELLSPACING=1>
74   * <caption>Comparison of Queue and Deque methods</caption>
75   *  <tr>
# Line 110 | Line 108 | package java.util;
108   * beginning of the deque.  Stack methods are precisely equivalent to
109   * {@code Deque} methods as indicated in the table below:
110   *
113 – * <p>
111   * <table BORDER CELLPADDING=3 CELLSPACING=1>
112   * <caption>Comparison of Stack and Deque methods</caption>
113   *  <tr>
# Line 162 | Line 159 | package java.util;
159   * @author Doug Lea
160   * @author Josh Bloch
161   * @since  1.6
162 < * @param <E> the type of elements held in this collection
162 > * @param <E> the type of elements held in this deque
163   */
164   public interface Deque<E> extends Queue<E> {
165      /**
166       * Inserts the specified element at the front of this deque if it is
167 <     * possible to do so immediately without violating capacity restrictions.
168 <     * When using a capacity-restricted deque, it is generally preferable to
169 <     * use method {@link #offerFirst}.
167 >     * possible to do so immediately without violating capacity restrictions,
168 >     * throwing an {@code IllegalStateException} if no space is currently
169 >     * available.  When using a capacity-restricted deque, it is generally
170 >     * preferable to use method {@link #offerFirst}.
171       *
172       * @param e the element to add
173       * @throws IllegalStateException if the element cannot be added at this
# Line 185 | Line 183 | public interface Deque<E> extends Queue<
183  
184      /**
185       * Inserts the specified element at the end of this deque if it is
186 <     * possible to do so immediately without violating capacity restrictions.
187 <     * When using a capacity-restricted deque, it is generally preferable to
188 <     * use method {@link #offerLast}.
186 >     * possible to do so immediately without violating capacity restrictions,
187 >     * throwing an {@code IllegalStateException} if no space is currently
188 >     * available.  When using a capacity-restricted deque, it is generally
189 >     * preferable to use method {@link #offerLast}.
190       *
191       * <p>This method is equivalent to {@link #add}.
192       *
# Line 316 | Line 315 | public interface Deque<E> extends Queue<
315       * Removes the first occurrence of the specified element from this deque.
316       * If the deque does not contain the element, it is unchanged.
317       * More formally, removes the first element {@code e} such that
318 <     * <tt>(o==null&nbsp;?&nbsp;e==null&nbsp;:&nbsp;o.equals(e))</tt>
320 <     * (if such an element exists).
318 >     * {@code Objects.equals(o, e)} (if such an element exists).
319       * Returns {@code true} if this deque contained the specified element
320       * (or equivalently, if this deque changed as a result of the call).
321       *
322       * @param o element to be removed from this deque, if present
323       * @return {@code true} if an element was removed as a result of this call
324       * @throws ClassCastException if the class of the specified element
325 <     *         is incompatible with this deque (optional)
325 >     *         is incompatible with this deque
326 >     * (<a href="{@docRoot}/../api/java/util/Collection.html#optional-restrictions">optional</a>)
327       * @throws NullPointerException if the specified element is null and this
328 <     *         deque does not permit null elements (optional)
328 >     *         deque does not permit null elements
329 >     * (<a href="{@docRoot}/../api/java/util/Collection.html#optional-restrictions">optional</a>)
330       */
331      boolean removeFirstOccurrence(Object o);
332  
# Line 334 | Line 334 | public interface Deque<E> extends Queue<
334       * Removes the last occurrence of the specified element from this deque.
335       * If the deque does not contain the element, it is unchanged.
336       * More formally, removes the last element {@code e} such that
337 <     * <tt>(o==null&nbsp;?&nbsp;e==null&nbsp;:&nbsp;o.equals(e))</tt>
338 <     * (if such an element exists).
337 >     * {@code Objects.equals(o, e)} (if such an element exists).
338       * Returns {@code true} if this deque contained the specified element
339       * (or equivalently, if this deque changed as a result of the call).
340       *
341       * @param o element to be removed from this deque, if present
342       * @return {@code true} if an element was removed as a result of this call
343       * @throws ClassCastException if the class of the specified element
344 <     *         is incompatible with this deque (optional)
344 >     *         is incompatible with this deque
345 >     * (<a href="{@docRoot}/../api/java/util/Collection.html#optional-restrictions">optional</a>)
346       * @throws NullPointerException if the specified element is null and this
347 <     *         deque does not permit null elements (optional)
347 >     *         deque does not permit null elements
348 >     * (<a href="{@docRoot}/../api/java/util/Collection.html#optional-restrictions">optional</a>)
349       */
350      boolean removeLastOccurrence(Object o);
351  
# Line 453 | Line 454 | public interface Deque<E> extends Queue<
454      /**
455       * Pushes an element onto the stack represented by this deque (in other
456       * words, at the head of this deque) if it is possible to do so
457 <     * immediately without violating capacity restrictions, returning
457 <     * {@code true} upon success and throwing an
457 >     * immediately without violating capacity restrictions, throwing an
458       * {@code IllegalStateException} if no space is currently available.
459       *
460       * <p>This method is equivalent to {@link #addFirst}.
# Line 490 | Line 490 | public interface Deque<E> extends Queue<
490       * Removes the first occurrence of the specified element from this deque.
491       * If the deque does not contain the element, it is unchanged.
492       * More formally, removes the first element {@code e} such that
493 <     * <tt>(o==null&nbsp;?&nbsp;e==null&nbsp;:&nbsp;o.equals(e))</tt>
494 <     * (if such an element exists).
493 >     * {@code Objects.equals(o, e)} (if such an element exists).
494       * Returns {@code true} if this deque contained the specified element
495       * (or equivalently, if this deque changed as a result of the call).
496       *
# Line 500 | Line 499 | public interface Deque<E> extends Queue<
499       * @param o element to be removed from this deque, if present
500       * @return {@code true} if an element was removed as a result of this call
501       * @throws ClassCastException if the class of the specified element
502 <     *         is incompatible with this deque (optional)
502 >     *         is incompatible with this deque
503 >     * (<a href="{@docRoot}/../api/java/util/Collection.html#optional-restrictions">optional</a>)
504       * @throws NullPointerException if the specified element is null and this
505 <     *         deque does not permit null elements (optional)
505 >     *         deque does not permit null elements
506 >     * (<a href="{@docRoot}/../api/java/util/Collection.html#optional-restrictions">optional</a>)
507       */
508      boolean remove(Object o);
509  
510      /**
511       * Returns {@code true} if this deque contains the specified element.
512       * More formally, returns {@code true} if and only if this deque contains
513 <     * at least one element {@code e} such that
513 <     * <tt>(o==null&nbsp;?&nbsp;e==null&nbsp;:&nbsp;o.equals(e))</tt>.
513 >     * at least one element {@code e} such that {@code Objects.equals(o, e)}.
514       *
515       * @param o element whose presence in this deque is to be tested
516       * @return {@code true} if this deque contains the specified element
517 <     * @throws ClassCastException if the type of the specified element
518 <     *         is incompatible with this deque (optional)
517 >     * @throws ClassCastException if the class of the specified element
518 >     *         is incompatible with this deque
519 >     * (<a href="{@docRoot}/../api/java/util/Collection.html#optional-restrictions">optional</a>)
520       * @throws NullPointerException if the specified element is null and this
521 <     *         deque does not permit null elements (optional)
521 >     *         deque does not permit null elements
522 >     * (<a href="{@docRoot}/../api/java/util/Collection.html#optional-restrictions">optional</a>)
523       */
524      boolean contains(Object o);
525  
# Line 526 | Line 528 | public interface Deque<E> extends Queue<
528       *
529       * @return the number of elements in this deque
530       */
531 <    public int size();
531 >    int size();
532  
533      /**
534       * Returns an iterator over the elements in this deque in proper sequence.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines