--- jsr166/src/main/java/util/Queue.java	2003/09/15 12:02:23	1.19
+++ jsr166/src/main/java/util/Queue.java	2005/05/02 08:35:49	1.27
@@ -1,15 +1,45 @@
 /*
  * Written by Doug Lea with assistance from members of JCP JSR-166
- * Expert Group and released to the public domain. Use, modify, and
- * redistribute this code in any way without acknowledgement.
+ * Expert Group and released to the public domain, as explained at
+ * http://creativecommons.org/licenses/publicdomain
  */
 
 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 <tt>null</tt> or <tt>false</tt>, depending on the
+ * operation).  The latter form of the insert operation is designed
+ * specifically for use with capacity-restricted <tt>Queue</tt>
+ * implementations; in most implementations, insert operations cannot
+ * fail.
+ *
+ * <p><table BORDER CELLPADDING=3 CELLSPACING=1>
+ *  <tr>
+ *    <td></td>
+ *    <td ALIGN=CENTER><em>Throws exception</em></td>
+ *    <td ALIGN=CENTER><em>Returns special value</em></td>
+ *  </tr>
+ *  <tr>
+ *    <td><b>Insert</b></td>
+ *    <td>{@link #add add(e)}</td>
+ *    <td>{@link #offer offer(e)}</td>
+ *  </tr>
+ *  <tr>
+ *    <td><b>Remove</b></td>
+ *    <td>{@link #remove remove()}</td>
+ *    <td>{@link #poll poll()}</td>
+ *  </tr>
+ *  <tr>
+ *    <td><b>Examine</b></td>
+ *    <td>{@link #element element()}</td>
+ *    <td>{@link #peek peek()}</td>
+ *  </tr>
+ * </table>
  *
  * <p>Queues typically, but do not necessarily, order elements in a
  * FIFO (first-in-first-out) manner.  Among the exceptions are
@@ -79,6 +109,7 @@ package java.util;
  * @see java.util.concurrent.PriorityBlockingQueue
  * @since 1.5
  * @author Doug Lea
+ * @param <E> the type of elements held in this collection
  */
 public interface Queue<E> extends Collection<E> {
 
@@ -89,11 +120,11 @@ public interface Queue<E> extends Collec
      * preferable to method {@link Collection#add}, which can fail to
      * insert an element only by throwing an exception.
      *
-     * @param o the element to insert.
+     * @param e the element to insert.
      * @return <tt>true</tt> if it was possible to add the element to
      * this queue, else <tt>false</tt>
      */
-    boolean offer(E o);
+    boolean offer(E e);
 
     /**
      * Retrieves and removes the head of this queue, or <tt>null</tt>
@@ -106,7 +137,7 @@ public interface Queue<E> extends Collec
 
     /**
      * Retrieves and removes the head of this queue.  This method
-     * differs from the <tt>poll</tt> 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.
@@ -125,7 +156,7 @@ public interface Queue<E> extends Collec
 
     /**
      * Retrieves, but does not remove, the head of this queue.  This method
-     * differs from the <tt>peek</tt> 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.