--- jsr166/src/jdk7/java/util/AbstractQueue.java 2012/12/16 20:55:09 1.1 +++ jsr166/src/jdk7/java/util/AbstractQueue.java 2013/01/16 01:39:37 1.2 @@ -9,16 +9,16 @@ 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. + * 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 + * 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 @@ -45,14 +45,14 @@ public abstract class AbstractQueue /** * 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 + * {@code true} upon success and throwing an {@code IllegalStateException} * if no space is currently available. * - *

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 @@ -74,7 +74,7 @@ public abstract class AbstractQueue * from {@link #poll poll} only in that it throws an exception if this * queue is empty. * - *

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 @@ -93,7 +93,7 @@ public abstract class AbstractQueue * differs from {@link #peek peek} only in that it throws an exception if * this queue is empty. * - *

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 @@ -112,7 +112,7 @@ public abstract class AbstractQueue * The queue will be empty after this call returns. * *

This implementation repeatedly invokes {@link #poll poll} until it - * returns null. + * returns {@code null}. */ public void clear() { while (poll() != null) @@ -122,7 +122,7 @@ public abstract class AbstractQueue /** * Adds all of the elements in the specified collection to this * queue. Attempts to addAll of a queue to itself result in - * IllegalArgumentException. Further, the behavior of + * {@code IllegalArgumentException}. Further, the behavior of * this operation is undefined if the specified collection is * modified while the operation is in progress. * @@ -130,12 +130,12 @@ public abstract class AbstractQueue * and adds each element returned by the iterator to this * queue, in turn. A runtime exception encountered while * trying to add an element (including, in particular, a - * null element) may result in only some of the elements + * {@code null} element) may result in only some of the elements * having been successfully added when the associated exception is * thrown. * * @param c collection containing elements to be added to this queue - * @return true if this queue changed as a result of the call + * @return {@code 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