--- jsr166/src/main/java/util/Queue.java 2003/07/28 04:11:54 1.8 +++ jsr166/src/main/java/util/Queue.java 2003/08/05 06:37:38 1.14 @@ -8,7 +8,7 @@ package java.util; /** * A collection designed for holding elements prior to processing. - * Besides basic {@link Collection} operations, queues provide + * Besides basic {@link java.util.Collection Collection} operations, queues provide * additional insertion, extraction, and inspection operations. * *

Queues typically, but do not necessarily, order elements in a @@ -18,15 +18,16 @@ package java.util; * stacks) which order the elements LIFO (last-in-first-out). * Whatever the ordering used, the head of the queue is that element * which would be removed by a call to {@link #remove() } or {@link #poll()}. - * Every Queue implementation must specify its ordering guarantees. + * Every Queue implementation must specify its ordering guarantees. * - *

The {@link #offer(E)} method adds an element if possible, otherwise - * returning false. This differs from the {@link - * Collections#add(Object)} method, which throws an unchecked exception upon + *

The {@link #offer offer} method adds an element if possible, otherwise + * returning false. This differs from the + * {@link java.util.Collection#add Collection.add} + * method, which throws an unchecked exception upon * failure. It is designed for use in collections in which failure to * add is a normal, rather than exceptional occurrence, for example, * in fixed-capacity (or "bounded") queues. - * + * *

The {@link #remove()} and {@link #poll()} methods remove and * return the head of the queue. * Exactly which element is removed from the queue is a @@ -37,7 +38,7 @@ package java.util; * while the poll() method returns null. * *

The {@link #element()} and {@link #peek()} methods return, but do - * not delete, the head of the queue. + * not remove, the head of the queue. * *

The Queue interface does not define the blocking queue * methods, which are common in concurrent programming. These methods, @@ -57,7 +58,7 @@ package java.util; * * Java Collections Framework. * - * @see Collection + * @see java.util.Collection * @see LinkedList * @see PriorityQueue * @see java.util.concurrent.LinkedQueue @@ -71,37 +72,37 @@ package java.util; public interface Queue extends Collection { /** - * Add the specified element to this queue, if possible. + * Adds the specified element to this queue, if possible. * - * @param element the element to add. - * @return true if it was possible to add the element to - * this queue. + * @param o the element to add. + * @return true if it was possible to add the element to + * this queue, else false */ - boolean offer(E element); + boolean offer(E o); /** - * Retrieve and remove the head of this queue, if it is available. + * Retrieves and removes the head of this queue, if it is available. * * @return the head of this queue, or null if this - * queue is empty. + * queue is empty. */ E poll(); /** - * Retrieve and remove the head of this queue. + * Retrieves and removes the head of this queue. * This method differs - * from the poll method in that it throws an exception if the - * queue is empty. + * from the poll method in that it throws an exception if this + * queue is empty. * * @return the head of this queue. * @throws NoSuchElementException if this queue is empty. */ - E remove() throws NoSuchElementException; + E remove(); /** - * Retrieve, but do not remove, the head of this queue, or null - * if this queue is empty. This method differs from the poll - * method only in that this method does not remove the element from + * Retrieves, but does not remove, the head of this queue. + * This method differs from the poll + * method only in that this method does not remove the head element from * this queue. * * @return the head of this queue, or null if this queue is empty. @@ -109,14 +110,14 @@ public interface Queue extends Collec E peek(); /** - * Retrieve, but do not remove, the head of this queue. This method - * differs from the peek method only in that it throws an + * Retrieves, but does not remove, the head of this queue. This method + * differs from the peek method only in that it throws an * exception if this queue is empty. * * @return the head of this queue. * @throws NoSuchElementException if this queue is empty. */ - E element() throws NoSuchElementException; + E element(); }