--- jsr166/src/main/java/util/AbstractQueue.java 2005/05/02 08:35:49 1.27 +++ jsr166/src/main/java/util/AbstractQueue.java 2005/05/16 04:55:20 1.29 @@ -43,18 +43,25 @@ public abstract class AbstractQueue protected AbstractQueue() { } - /** - * Adds the specified element to this queue. This implementation - * returns true if offer succeeds, else - * throws an IllegalStateException. - * - * @param e the element - * @return true (as per the general contract of - * Collection.add). - * - * @throws NullPointerException if the specified element is null. - * @throws IllegalStateException if the element cannot be added. + * Inserts the specified element into this queue if it is possible to do so + * immediately without violating capacity restrictions, returning + * true upon success and throwing an IllegalStateException + * if no space is currently available. + * + *

This implementation returns true if offer succeeds, + * else throws an IllegalStateException. + * + * @param e the element to add + * @return true (as per the spec for {@link Collection#add}) + * @throws IllegalStateException if the element cannot be added at this + * time due to capacity restrictions + * @throws ClassCastException if the class of the specified element + * prevents it from being added to this queue + * @throws NullPointerException if the specified element is null and + * this queue not permit null elements + * @throws IllegalArgumentException if some property of this element + * prevents it from being added to this queue */ public boolean add(E e) { if (offer(e)) @@ -64,12 +71,15 @@ public abstract class AbstractQueue } /** - * Retrieves and removes the head of this queue. - * This implementation returns the result of poll + * Retrieves and removes the head of this queue. This method differs + * from {@link #poll} only in that it throws an exception if this queue + * is empty. + * + *

This implementation returns the result of poll * unless the queue is empty. * - * @return the head of this queue. - * @throws NoSuchElementException if this queue is empty. + * @return the head of this queue + * @throws NoSuchElementException if this queue is empty */ public E remove() { E x = poll(); @@ -80,12 +90,15 @@ public abstract class AbstractQueue } /** - * Retrieves, but does not remove, the head of this queue. - * This implementation returns the result of peek + * Retrieves, but does not remove, the head of this queue. This method + * differs from {@link #peek} only in that it throws an exception if + * this queue is empty. + * + *

This implementation returns the result of peek * unless the queue is empty. * - * @return the head of this queue. - * @throws NoSuchElementException if this queue is empty. + * @return the head of this queue + * @throws NoSuchElementException if this queue is empty */ public E element() { E x = peek(); @@ -98,6 +111,7 @@ public abstract class AbstractQueue /** * Removes all of the elements from this queue. * The queue will be empty after this call returns. + * *

This implementation repeatedly invokes {@link #poll poll} until it * returns null. */ @@ -121,13 +135,18 @@ public abstract class AbstractQueue * having been successfully added when the associated exception is * thrown. * - * @param c collection whose elements are to be added to this queue. - * @return true if this queue changed as a result of the - * call. - * @throws NullPointerException if the specified collection or - * any of its elements are null. - * @throws IllegalArgumentException if c is this queue. - * + * @param c collection whose elements are to be added to this queue + * @return true if this queue changed as a result of the call + * @throws ClassCastException if the class of an element of the specified + * collection prevents it from being added to this queue + * @throws NullPointerException if the specified collection contains a + * null element and this queue does not permit null elements, + * or if the specified collection is null + * @throws IllegalArgumentException if some property of an element of the + * specified collection prevents it from being added to this + * queue, or if the specified collection is this queue + * @throws IllegalStateException if not all the elements can be added at + * this time due to insertion restrictions * @see #add(Object) */ public boolean addAll(Collection c) {