--- jsr166/src/jsr166y/TransferQueue.java 2007/07/11 14:30:37 1.2 +++ jsr166/src/jsr166y/TransferQueue.java 2009/08/01 20:26:50 1.9 @@ -9,23 +9,25 @@ import java.util.concurrent.*; /** * A {@link BlockingQueue} in which producers may wait for consumers - * to receive elements. A TransferQueue may be useful for + * to receive elements. A {@code TransferQueue} may be useful for * example in message passing applications in which producers - * sometimes (using method transfer) await receipt of - * elements by consumers invoking take or poll, - * while at other times enqueue elements (via method put) - * without waiting for receipt. Non-blocking and time-out versions of - * tryTransfer are also available. A TransferQueue may also - * be queried via hasWaitingConsumer whether there are any - * threads waiting for items, which is a converse analogy to a - * peek operation + * sometimes (using method {@link #transfer}) await receipt of + * elements by consumers invoking {@code take} or {@code poll}, while + * at other times enqueue elements (via method {@code put}) without + * waiting for receipt. {@linkplain + * #tryTransfer(Object) Non-blocking} and {@linkplain + * #tryTransfer(Object,long,TimeUnit) time-out} versions of {@code + * tryTransfer} are also available. A {@code TransferQueue} may also + * be queried, via {@link #hasWaitingConsumer}, whether there are any + * threads waiting for items, which is a converse analogy to a {@code + * peek} operation. * - *
Like any BlockingQueue, a TransferQueue may be - * capacity bounded. If so, an attempted transfer operation + *
Like other blocking queues, a {@code TransferQueue} may be + * capacity bounded. If so, an attempted {@code transfer} operation * may initially block waiting for available space, and/or * subsequently block waiting for reception by a consumer. Note that * in a queue with zero capacity, such as {@link SynchronousQueue}, - * put and transfer are effectively synonymous. + * {@code put} and {@code transfer} are effectively synonymous. * *