--- jsr166/src/main/java/util/Queue.java 2003/06/23 02:26:15 1.6 +++ jsr166/src/main/java/util/Queue.java 2003/06/24 14:34:30 1.7 @@ -25,15 +25,16 @@ package java.util; * in fixed-capacity (or “bounded”) queues. * - *

The {@link #remove()} and {@link #poll()} methods remove and return an - * element in accord with the implementation's ordering policy. - * Exactly which element is removed from the queue is a function - * of the queue's ordering policy, which differs from implementation - * to implementation. Possible orderings include (but are not limited - * to) first-in-first-out (FIFO), last-in-first-out (LIFO), element priority, and arbitrary. - * The remove() and poll() methods differ only in their - * behavior when the queue is empty: the remove() method throws an - * exception, while the poll() method returns null. + *

The {@link #remove()} and {@link #poll()} methods remove and + * return an element in accord with the implementation's ordering + * policy. Exactly which element is removed from the queue is a + * function of the queue's ordering policy, which differs from + * implementation to implementation. Possible orderings include (but + * are not limited to) first-in-first-out (FIFO), last-in-first-out + * (LIFO), element priority, and arbitrary. The remove() and + * poll() methods differ only in their behavior when the + * queue is empty: the remove() method throws an exception, + * while the poll() method returns null. * *

The {@link #element()} and {@link #peek()} methods return but do * not delete the element that would be obtained by a call to @@ -45,13 +46,13 @@ package java.util; * defined in the {@link java.util.concurrent.BlockingQueue} interface, which * extends this interface. * - *

Queue implementations generally do not allow insertion of - * null elements, although some implementations, such as + *

Queue implementations generally do not allow insertion + * of null elements, although some implementations, such as * {@link LinkedList}, do not prohibit insertion of null. - * Even in the implementations that permit it, null should not be inserted into - * a Queue, as null is also used as a special return value - * by the poll method to indicate that the queue contains no - * elements. + * Even in the implementations that permit it, null should + * not be inserted into a Queue, as null is also + * used as a special return value by the poll method to + * indicate that the queue contains no elements. * *

This interface is a member of the * @@ -65,6 +66,8 @@ package java.util; * @see java.util.concurrent.ArrayBlockingQueue * @see java.util.concurrent.LinkedBlockingQueue * @see java.util.concurrent.PriorityBlockingQueue + * @since 1.5 + * @author Doug Lea */ public interface Queue extends Collection { /** @@ -73,7 +76,7 @@ public interface Queue extends Collec * @param element the element to add. * @return true if it was possible to add the element to the queue. */ - public boolean offer(E element); + boolean offer(E element); /** * Remove and return an element from the queue if one is available. @@ -81,7 +84,7 @@ public interface Queue extends Collec * @return an element previously on the queue, or null if the * queue is empty. */ - public E poll(); + E poll(); /** * Remove and return an element from the queue. This method differs @@ -91,7 +94,7 @@ public interface Queue extends Collec * @return an element previously on the queue. * @throws NoSuchElementException if the queue is empty. */ - public E remove() throws NoSuchElementException; + E remove() throws NoSuchElementException; /** * Return, but do not remove, an element from the queue, or null @@ -101,7 +104,7 @@ public interface Queue extends Collec * * @return an element on the queue, or null if the queue is empty. */ - public E peek(); + E peek(); /** * Return, but do not remove, an element from the queue. This method @@ -111,5 +114,5 @@ public interface Queue extends Collec * @return an element on the queue. * @throws NoSuchElementException if the queue is empty. */ - public E element() throws NoSuchElementException; + E element() throws NoSuchElementException; }