--- jsr166/src/jsr166x/BlockingDeque.java 2011/03/15 19:47:02 1.4
+++ jsr166/src/jsr166x/BlockingDeque.java 2013/01/16 00:51:11 1.7
@@ -43,17 +43,17 @@ import java.util.*;
*
*
*
- *
Like any {@link BlockingQueue}, a BlockingDeque is
+ *
Like any {@link BlockingQueue}, a {@code BlockingDeque} is
* thread safe and may (or may not) be capacity-constrained. A
- * BlockingDeque implementation may be used directly as a
- * FIFO BlockingQueue. The blocking methods inherited from
- * the BlockingQueue interface are precisely equivalent to
- * BlockingDeque methods as indicated in the following table:
+ * {@code BlockingDeque} implementation may be used directly as a
+ * FIFO {@code BlockingQueue}. The blocking methods inherited from
+ * the {@code BlockingQueue} interface are precisely equivalent to
+ * {@code BlockingDeque} methods as indicated in the following table:
*
*
*
- * BlockingQueue Method |
- * Equivalent BlockingDeque Method |
+ * {@code BlockingQueue} Method |
+ * Equivalent {@code BlockingDeque} Method |
*
*
*
@@ -89,8 +89,8 @@ public interface BlockingDeque extend
* Adds the specified element as the first element of this deque,
* waiting if necessary for space to become available.
* @param o the element to add
- * @throws InterruptedException if interrupted while waiting.
- * @throws NullPointerException if the specified element is null.
+ * @throws InterruptedException if interrupted while waiting
+ * @throws NullPointerException if the specified element is {@code null}
*/
void putFirst(E o) throws InterruptedException;
@@ -98,8 +98,8 @@ public interface BlockingDeque extend
* Adds the specified element as the last element of this deque,
* waiting if necessary for space to become available.
* @param o the element to add
- * @throws InterruptedException if interrupted while waiting.
- * @throws NullPointerException if the specified element is null.
+ * @throws InterruptedException if interrupted while waiting
+ * @throws NullPointerException if the specified element is {@code null}
*/
void putLast(E o) throws InterruptedException;
@@ -107,7 +107,7 @@ public interface BlockingDeque extend
* Retrieves and removes the first element of this deque, waiting
* if no elements are present on this deque.
* @return the head of this deque
- * @throws InterruptedException if interrupted while waiting.
+ * @throws InterruptedException if interrupted while waiting
*/
E takeFirst() throws InterruptedException;
@@ -115,7 +115,7 @@ public interface BlockingDeque extend
* Retrieves and removes the last element of this deque, waiting
* if no elements are present on this deque.
* @return the head of this deque
- * @throws InterruptedException if interrupted while waiting.
+ * @throws InterruptedException if interrupted while waiting
*/
E takeLast() throws InterruptedException;
@@ -125,13 +125,13 @@ public interface BlockingDeque extend
* become available.
* @param o the element to add
* @param timeout how long to wait before giving up, in units of
- * unit
- * @param unit a TimeUnit determining how to interpret the
- * timeout parameter
- * @return true if successful, or false if
- * the specified waiting time elapses before space is available.
- * @throws InterruptedException if interrupted while waiting.
- * @throws NullPointerException if the specified element is null.
+ * {@code unit}
+ * @param unit a {@code TimeUnit} determining how to interpret the
+ * {@code timeout} parameter
+ * @return {@code true} if successful, or {@code false} if
+ * the specified waiting time elapses before space is available
+ * @throws InterruptedException if interrupted while waiting
+ * @throws NullPointerException if the specified element is {@code null}
*/
boolean offerFirst(E o, long timeout, TimeUnit unit)
throws InterruptedException;
@@ -142,13 +142,13 @@ public interface BlockingDeque extend
* become available.
* @param o the element to add
* @param timeout how long to wait before giving up, in units of
- * unit
- * @param unit a TimeUnit determining how to interpret the
- * timeout parameter
- * @return true if successful, or false if
- * the specified waiting time elapses before space is available.
- * @throws InterruptedException if interrupted while waiting.
- * @throws NullPointerException if the specified element is null.
+ * {@code unit}
+ * @param unit a {@code TimeUnit} determining how to interpret the
+ * {@code timeout} parameter
+ * @return {@code true} if successful, or {@code false} if
+ * the specified waiting time elapses before space is available
+ * @throws InterruptedException if interrupted while waiting
+ * @throws NullPointerException if the specified element is {@code null}
*/
boolean offerLast(E o, long timeout, TimeUnit unit)
throws InterruptedException;
@@ -159,12 +159,12 @@ public interface BlockingDeque extend
* if necessary up to the specified wait time if no elements are
* present on this deque.
* @param timeout how long to wait before giving up, in units of
- * unit
- * @param unit a TimeUnit determining how to interpret the
- * timeout parameter
- * @return the head of this deque, or null if the
- * specified waiting time elapses before an element is present.
- * @throws InterruptedException if interrupted while waiting.
+ * {@code unit}
+ * @param unit a {@code TimeUnit} determining how to interpret the
+ * {@code timeout} parameter
+ * @return the head of this deque, or {@code null} if the
+ * specified waiting time elapses before an element is present
+ * @throws InterruptedException if interrupted while waiting
*/
E pollFirst(long timeout, TimeUnit unit)
throws InterruptedException;
@@ -174,12 +174,12 @@ public interface BlockingDeque extend
* if necessary up to the specified wait time if no elements are
* present on this deque.
* @param timeout how long to wait before giving up, in units of
- * unit
- * @param unit a TimeUnit determining how to interpret the
- * timeout parameter
- * @return the head of this deque, or null if the
- * specified waiting time elapses before an element is present.
- * @throws InterruptedException if interrupted while waiting.
+ * {@code unit}
+ * @param unit a {@code TimeUnit} determining how to interpret the
+ * {@code timeout} parameter
+ * @return the head of this deque, or {@code null} if the
+ * specified waiting time elapses before an element is present
+ * @throws InterruptedException if interrupted while waiting
*/
E pollLast(long timeout, TimeUnit unit)
throws InterruptedException;
@@ -187,10 +187,10 @@ public interface BlockingDeque extend
/**
* Adds the specified element as the last element of this deque,
* waiting if necessary for space to become available. This
- * method is equivalent to putLast
+ * method is equivalent to putLast.
* @param o the element to add
- * @throws InterruptedException if interrupted while waiting.
- * @throws NullPointerException if the specified element is null.
+ * @throws InterruptedException if interrupted while waiting
+ * @throws NullPointerException if the specified element is {@code null}
*/
void put(E o) throws InterruptedException;
@@ -198,15 +198,15 @@ public interface BlockingDeque extend
* Inserts the specified element as the lest element of this
* deque, if possible. When using deques that may impose
* insertion restrictions (for example capacity bounds), method
- * offer is generally preferable to method {@link
+ * {@code offer} is generally preferable to method {@link
* Collection#add}, which can fail to insert an element only by
* throwing an exception. This method is equivalent to
- * offerLast
+ * offerLast.
*
- * @param o the element to add.
- * @return true if it was possible to add the element to
- * this deque, else false
- * @throws NullPointerException if the specified element is null
+ * @param o the element to add
+ * @return {@code true} if it was possible to add the element to
+ * this deque, else {@code false}
+ * @throws NullPointerException if the specified element is {@code null}
*/
boolean offer(E o, long timeout, TimeUnit unit)
throws InterruptedException;
@@ -214,9 +214,9 @@ public interface BlockingDeque extend
/**
* Retrieves and removes the first element of this deque, waiting
* if no elements are present on this deque.
- * This method is equivalent to takeFirst
+ * This method is equivalent to takeFirst.
* @return the head of this deque
- * @throws InterruptedException if interrupted while waiting.
+ * @throws InterruptedException if interrupted while waiting
*/
E take() throws InterruptedException;
@@ -224,14 +224,14 @@ public interface BlockingDeque extend
* Retrieves and removes the first element of this deque, waiting
* if necessary up to the specified wait time if no elements are
* present on this deque. This method is equivalent to
- * pollFirst
+ * pollFirst.
* @param timeout how long to wait before giving up, in units of
- * unit
- * @param unit a TimeUnit determining how to interpret the
- * timeout parameter
- * @return the head of this deque, or null if the
- * specified waiting time elapses before an element is present.
- * @throws InterruptedException if interrupted while waiting.
+ * {@code unit}
+ * @param unit a {@code TimeUnit} determining how to interpret the
+ * {@code timeout} parameter
+ * @return the head of this deque, or {@code null} if the
+ * specified waiting time elapses before an element is present
+ * @throws InterruptedException if interrupted while waiting
*/
E poll(long timeout, TimeUnit unit)
throws InterruptedException;