See Also: IBlockingDeque Members
A Java.Util.IDeque that additionally supports blocking operations that wait for the deque to become non-empty when retrieving an element, and wait for space to become available in the deque when storing an element.
BlockingDeque methods come in four forms, with different ways of handling operations that cannot be satisfied immediately, but may be satisfied at some point in the future: one throws an exception, the second returns a special value (either null or false, depending on the operation), the third blocks the current thread indefinitely until the operation can succeed, and the fourth blocks for only a given maximum time limit before giving up. These methods are summarized in the following table:
| First Element (Head) | ||||
| Throws exception | Special value | Blocks | Times out | |
| Insert | IBlockingDeque.addFirst(E) | IBlockingDeque.offerFirst(E) | IBlockingDeque.putFirst(E) | IBlockingDeque.offerFirst(E, long, java.util.concurrent.TimeUnit) |
| Remove | Java.Util.IDeque.RemoveFirst | Java.Util.IDeque.PollFirst | IBlockingDeque.TakeFirst | IBlockingDeque.PollFirst(long, Java.Util.Concurrent.TimeUnit) |
| Examine | Java.Util.IDeque.First | Java.Util.IDeque.PeekFirst | not applicable | not applicable |
| Last Element (Tail) | ||||
| Throws exception | Special value | Blocks | Times out | |
| Insert | IBlockingDeque.addLast(E) | IBlockingDeque.offerLast(E) | IBlockingDeque.putLast(E) | IBlockingDeque.offerLast(E, long, java.util.concurrent.TimeUnit) |
| Remove | Java.Util.IDeque.RemoveLast | Java.Util.IDeque.PollLast | IBlockingDeque.TakeLast | IBlockingDeque.PollLast(long, Java.Util.Concurrent.TimeUnit) |
| Examine | Java.Util.IDeque.Last | Java.Util.IDeque.PeekLast | not applicable | not applicable |
Like any Java.Util.Concurrent.IBlockingQueue, a BlockingDeque is thread safe, does not permit null elements, and may (or may not) be capacity-constrained.
A BlockingDeque implementation may be used directly as a FIFO BlockingQueue. The methods inherited from the BlockingQueue interface are precisely equivalent to BlockingDeque methods as indicated in the following table:
Memory consistency effects: As with other concurrent collections, actions in a thread prior to placing an object into a BlockingDeque actions subsequent to the access or removal of that element from the BlockingDeque in another thread.
This interface is a member of the Java Collections Framework.