src/share/classes/java/util/Deque.java

rev 3977 : 6546713: link the word (optional) in exception specifications to the text which provides explanation and context.

*** 349,361 ****
       * (or equivalently, if this deque changed as a result of the call).
       *
       * @param o element to be removed from this deque, if present
       * @return <tt>true</tt> if an element was removed as a result of this call
       * @throws ClassCastException if the class of the specified element
!      *         is incompatible with this deque (optional)
       * @throws NullPointerException if the specified element is null and this
!      *         deque does not permit null elements (optional)
       */
      boolean removeFirstOccurrence(Object o);
  
      /**
       * Removes the last occurrence of the specified element from this deque.
--- 349,363 ----
       * (or equivalently, if this deque changed as a result of the call).
       *
       * @param o element to be removed from this deque, if present
       * @return <tt>true</tt> if an element was removed as a result of this call
       * @throws ClassCastException if the class of the specified element
!      *         is incompatible with this deque
!      * (<a href="Collection.html#optional-restrictions">optional</a>)
       * @throws NullPointerException if the specified element is null and this
!      *         deque does not permit null elements
!      * (<a href="Collection.html#optional-restrictions">optional</a>)
       */
      boolean removeFirstOccurrence(Object o);
  
      /**
       * Removes the last occurrence of the specified element from this deque.
*** 367,379 ****
       * (or equivalently, if this deque changed as a result of the call).
       *
       * @param o element to be removed from this deque, if present
       * @return <tt>true</tt> if an element was removed as a result of this call
       * @throws ClassCastException if the class of the specified element
!      *         is incompatible with this deque (optional)
       * @throws NullPointerException if the specified element is null and this
!      *         deque does not permit null elements (optional)
       */
      boolean removeLastOccurrence(Object o);
  
      // *** Queue methods ***
  
--- 369,383 ----
       * (or equivalently, if this deque changed as a result of the call).
       *
       * @param o element to be removed from this deque, if present
       * @return <tt>true</tt> if an element was removed as a result of this call
       * @throws ClassCastException if the class of the specified element
!      *         is incompatible with this deque
!      * (<a href="Collection.html#optional-restrictions">optional</a>)
       * @throws NullPointerException if the specified element is null and this
!      *         deque does not permit null elements
!      * (<a href="Collection.html#optional-restrictions">optional</a>)
       */
      boolean removeLastOccurrence(Object o);
  
      // *** Queue methods ***
  
*** 525,537 ****
       * <p>This method is equivalent to {@link #removeFirstOccurrence}.
       *
       * @param o element to be removed from this deque, if present
       * @return <tt>true</tt> if an element was removed as a result of this call
       * @throws ClassCastException if the class of the specified element
!      *         is incompatible with this deque (optional)
       * @throws NullPointerException if the specified element is null and this
!      *         deque does not permit null elements (optional)
       */
      boolean remove(Object o);
  
      /**
       * Returns <tt>true</tt> if this deque contains the specified element.
--- 529,543 ----
       * <p>This method is equivalent to {@link #removeFirstOccurrence}.
       *
       * @param o element to be removed from this deque, if present
       * @return <tt>true</tt> if an element was removed as a result of this call
       * @throws ClassCastException if the class of the specified element
!      *         is incompatible with this deque
!      * (<a href="Collection.html#optional-restrictions">optional</a>)
       * @throws NullPointerException if the specified element is null and this
!      *         deque does not permit null elements
!      * (<a href="Collection.html#optional-restrictions">optional</a>)
       */
      boolean remove(Object o);
  
      /**
       * Returns <tt>true</tt> if this deque contains the specified element.
*** 540,552 ****
       * <tt>(o==null&nbsp;?&nbsp;e==null&nbsp;:&nbsp;o.equals(e))</tt>.
       *
       * @param o element whose presence in this deque is to be tested
       * @return <tt>true</tt> if this deque contains the specified element
       * @throws ClassCastException if the type of the specified element
!      *         is incompatible with this deque (optional)
       * @throws NullPointerException if the specified element is null and this
!      *         deque does not permit null elements (optional)
       */
      boolean contains(Object o);
  
      /**
       * Returns the number of elements in this deque.
--- 546,560 ----
       * <tt>(o==null&nbsp;?&nbsp;e==null&nbsp;:&nbsp;o.equals(e))</tt>.
       *
       * @param o element whose presence in this deque is to be tested
       * @return <tt>true</tt> if this deque contains the specified element
       * @throws ClassCastException if the type of the specified element
!      *         is incompatible with this deque
!      * (<a href="Collection.html#optional-restrictions">optional</a>)
       * @throws NullPointerException if the specified element is null and this
!      *         deque does not permit null elements
!      * (<a href="Collection.html#optional-restrictions">optional</a>)
       */
      boolean contains(Object o);
  
      /**
       * Returns the number of elements in this deque.