--- jsr166/src/main/java/util/Queue.java 2003/08/30 11:40:04 1.16 +++ jsr166/src/main/java/util/Queue.java 2003/09/12 15:38:26 1.17 @@ -16,17 +16,20 @@ package java.util; * priority queues, which order elements according to a supplied * comparator, or the elements' natural ordering, and LIFO queues (or * 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. - * - *

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. + * 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()}. In a FIFO queue, all new elements are inserted at + * the tail of the queue. Other kinds of queues may use + * different placement rules. Every Queue implementation + * must specify its ordering properties. + * + *

The {@link #offer offer} method inserts an element if possible, + * otherwise returning false. This differs from the {@link + * java.util.Collection#add Collection.add} method, which can fail to + * add an element only by throwing an unchecked exception. The + * offer method is designed for use when failure 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. @@ -80,9 +83,13 @@ package java.util; public interface Queue extends Collection { /** - * Adds the specified element to this queue, if possible. + * Inserts the specified element to this queue, if possible. When + * using queues that may impose insertion restrictions (for + * example capacity bounds), method offer is generally + * preferable to method {@link Collection#add}, which can fail to + * insert an element only by throwing an exception. * - * @param o the element to add. + * @param o the element to insert. * @return true if it was possible to add the element to * this queue, else false */ @@ -127,13 +134,3 @@ public interface Queue extends Collec */ E element(); } - - - - - - - - - -