--- jsr166/src/main/java/util/Deque.java 2005/05/18 03:45:35 1.13 +++ jsr166/src/main/java/util/Deque.java 2011/03/15 19:47:02 1.20 @@ -1,7 +1,7 @@ /* * Written by Doug Lea and Josh Bloch with assistance from members of * JCP JSR-166 Expert Group and released to the public domain, as explained - * at http://creativecommons.org/licenses/publicdomain + * at http://creativecommons.org/publicdomain/zero/1.0/ */ package java.util; @@ -153,7 +153,7 @@ package java.util; * Object. * *

This interface is a member of the Java Collections + * href="{@docRoot}/../technotes/guides/collections/index.html"> Java Collections * Framework. * * @author Doug Lea @@ -187,6 +187,8 @@ public interface Deque extends Queue< * When using a capacity-restricted deque, it is generally preferable to * use method {@link #offerLast}. * + *

This method is equivalent to {@link #add}. + * * @param e the element to add * @throws IllegalStateException if the element cannot be added at this * time due to capacity restrictions @@ -237,8 +239,8 @@ public interface Deque extends Queue< /** * Retrieves and removes the first element of this deque. This method - * differs from {@link #pollFirst} only in that it throws an exception - * if this deque is empty. + * differs from {@link #pollFirst pollFirst} only in that it throws an + * exception if this deque is empty. * * @return the head of this deque * @throws NoSuchElementException if this deque is empty @@ -247,8 +249,8 @@ public interface Deque extends Queue< /** * Retrieves and removes the last element of this deque. This method - * differs from {@link #pollLast} only in that it throws an exception if - * this deque is empty. + * differs from {@link #pollLast pollLast} only in that it throws an + * exception if this deque is empty. * * @return the tail of this deque * @throws NoSuchElementException if this deque is empty @@ -273,8 +275,9 @@ public interface Deque extends Queue< /** * Retrieves, but does not remove, the first element of this deque. - * This method differs from {@link #peekFirst} only in that it throws an - * exception if this deque is empty. + * + * This method differs from {@link #peekFirst peekFirst} only in that it + * throws an exception if this deque is empty. * * @return the head of this deque * @throws NoSuchElementException if this deque is empty @@ -283,8 +286,8 @@ public interface Deque extends Queue< /** * Retrieves, but does not remove, the last element of this deque. - * This method differs from {@link #peekLast} only in that it throws an - * exception if this deque is empty. + * This method differs from {@link #peekLast peekLast} only in that it + * throws an exception if this deque is empty. * * @return the tail of this deque * @throws NoSuchElementException if this deque is empty @@ -354,10 +357,10 @@ public interface Deque extends Queue< * When using a capacity-restricted deque, it is generally preferable to * use {@link #offer(Object) offer}. * - *

This method is equivalent to {@link #addLast(Object) addLast}. + *

This method is equivalent to {@link #addLast}. * * @param e the element to add - * @return true (as per the spec for {@link Collection#add}) + * @return true (as specified by {@link Collection#add}) * @throws IllegalStateException if the element cannot be added at this * time due to capacity restrictions * @throws ClassCastException if the class of the specified element @@ -395,7 +398,7 @@ public interface Deque extends Queue< /** * Retrieves and removes the head of the queue represented by this deque * (in other words, the first element of this deque). - * This method differs from {@link #poll} only in that it throws an + * This method differs from {@link #poll poll} only in that it throws an * exception if this deque is empty. * *

This method is equivalent to {@link #removeFirst()}. @@ -420,7 +423,7 @@ public interface Deque extends Queue< /** * Retrieves, but does not remove, the head of the queue represented by * this deque (in other words, the first element of this deque). - * This method differs from {@link #peek} only in that it throws an + * This method differs from {@link #peek peek} only in that it throws an * exception if this deque is empty. * *

This method is equivalent to {@link #getFirst()}. @@ -530,4 +533,15 @@ public interface Deque extends Queue< * @return an iterator over the elements in this deque in proper sequence */ Iterator iterator(); + + /** + * Returns an iterator over the elements in this deque in reverse + * sequential order. The elements will be returned in order from + * last (tail) to first (head). + * + * @return an iterator over the elements in this deque in reverse + * sequence + */ + Iterator descendingIterator(); + }