--- jsr166/src/main/java/util/Queue.java 2003/12/27 19:26:15 1.22 +++ jsr166/src/main/java/util/Queue.java 2005/05/02 04:19:58 1.26 @@ -8,8 +8,38 @@ package java.util; /** * A collection designed for holding elements prior to processing. - * Besides basic {@link java.util.Collection Collection} operations, queues provide - * additional insertion, extraction, and inspection operations. + * Besides basic {@link java.util.Collection Collection} operations, + * queues provide additional insertion, extraction, and inspection + * operations. Each of these methods exists in two forms: one throws + * an exception if the operation fails, the other returns a special + * value (either null or false, depending on the + * operation). The latter form of the insert operation is designed + * specifically for use with capacity-restricted Queue + * implementations; in most implementations, insert operations cannot + * fail. + * + *

+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
Throws exceptionReturns special value
Insert{@link #add add(e)}{@link #offer offer(e)}
Remove{@link #remove remove()}{@link #poll poll()}
Examine{@link #element element()}{@link #peek peek()}
* *

Queues typically, but do not necessarily, order elements in a * FIFO (first-in-first-out) manner. Among the exceptions are @@ -107,7 +137,7 @@ public interface Queue extends Collec /** * Retrieves and removes the head of this queue. This method - * differs from the poll method in that it throws an + * differs from the {@link #poll} method only in that it throws an * exception if this queue is empty. * * @return the head of this queue. @@ -126,7 +156,7 @@ public interface Queue extends Collec /** * Retrieves, but does not remove, the head of this queue. This method - * differs from the peek method only in that it throws an + * differs from the {@link #peek} method only in that it throws an * exception if this queue is empty. * * @return the head of this queue.