--- jsr166/src/main/java/util/AbstractQueue.java 2006/03/03 17:15:06 1.33 +++ jsr166/src/main/java/util/AbstractQueue.java 2013/01/16 01:59:47 1.38 @@ -1,7 +1,7 @@ /* * Written by Doug Lea with assistance from members of JCP JSR-166 * Expert Group and released to the public domain, as explained at - * http://creativecommons.org/licenses/publicdomain + * http://creativecommons.org/publicdomain/zero/1.0/ */ package java.util; @@ -9,24 +9,23 @@ package java.util; /** * This class provides skeletal implementations of some {@link Queue} * operations. The implementations in this class are appropriate when - * the base implementation does not allow null + * the base implementation does not allow {@code null} * elements. Methods {@link #add add}, {@link #remove remove}, and * {@link #element element} are based on {@link #offer offer}, {@link - * #poll poll}, and {@link #peek peek}, respectively but throw - * exceptions instead of indicating failure via false or - * null returns. + * #poll poll}, and {@link #peek peek}, respectively, but throw + * exceptions instead of indicating failure via {@code false} or + * {@code null} returns. * - *
A Queue implementation that extends this class must + *
A {@code Queue} implementation that extends this class must * minimally define a method {@link Queue#offer} which does not permit - * insertion of null elements, along with methods {@link - * Queue#peek}, {@link Queue#poll}, {@link Collection#size}, and a - * {@link Collection#iterator} supporting {@link - * Iterator#remove}. Typically, additional methods will be overridden - * as well. If these requirements cannot be met, consider instead - * subclassing {@link AbstractCollection}. + * insertion of {@code null} elements, along with methods {@link + * Queue#peek}, {@link Queue#poll}, {@link Collection#size}, and + * {@link Collection#iterator}. Typically, additional methods will be + * overridden as well. If these requirements cannot be met, consider + * instead subclassing {@link AbstractCollection}. * *
This class is a member of the
- *
+ *
* Java Collections Framework.
*
* @since 1.5
@@ -46,14 +45,14 @@ public abstract class AbstractQueue This implementation returns true if offer succeeds,
- * else throws an IllegalStateException.
+ * This implementation returns {@code true} if {@code offer} succeeds,
+ * else throws an {@code IllegalStateException}.
*
* @param e the element to add
- * @return true (as specified by {@link Collection#add})
+ * @return {@code true} (as specified by {@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
@@ -75,7 +74,7 @@ public abstract class AbstractQueue This implementation returns the result of poll
+ * This implementation returns the result of {@code poll}
* unless the queue is empty.
*
* @return the head of this queue
@@ -94,7 +93,7 @@ public abstract class AbstractQueue This implementation returns the result of peek
+ * This implementation returns the result of {@code peek}
* unless the queue is empty.
*
* @return the head of this queue
@@ -113,7 +112,7 @@ public abstract class AbstractQueue This implementation repeatedly invokes {@link #poll poll} until it
- * returns null.
+ * returns {@code null}.
*/
public void clear() {
while (poll() != null)
@@ -123,7 +122,7 @@ public abstract class AbstractQueue