Class ForwardingBlockingDeque<E>
- All Implemented Interfaces:
Iterable<E>
,Collection<E>
,BlockingDeque<E>
,BlockingQueue<E>
,Deque<E>
,Queue<E>
,SequencedCollection<E>
BlockingDeque
which forwards all its method calls to another BlockingDeque
.
Subclasses should override one or more methods to modify the behavior of the backing deque as
desired per the decorator pattern.
Warning: The methods of ForwardingBlockingDeque
forward indiscriminately
to the methods of the delegate. For example, overriding ForwardingCollection.add(E)
alone will not change
the behaviour of offer(E, long, java.util.concurrent.TimeUnit)
which can lead to unexpected behaviour. In this case, you should
override offer
as well, either providing your own implementation, or delegating to the
provided standardOffer
method.
default
method warning: This class does not forward calls to
default
methods. Instead, it inherits their default implementations. When those implementations
invoke methods, they invoke methods on the ForwardingBlockingDeque
.
The standard
methods are not guaranteed to be thread-safe, even when all of the
methods that they depend on are thread-safe.
- Since:
- 21.0 (since 14.0 as
ForwardingBlockingDeque
) - Author:
- Emily Soldal
-
Constructor Summary
ModifierConstructorDescriptionprotected
Constructor for use by subclasses. -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract BlockingDeque
<E> delegate()
Returns the backing delegate instance that methods are forwarded to.int
drainTo
(Collection<? super E> c) int
drainTo
(Collection<? super E> c, int maxElements) boolean
boolean
offerFirst
(E e, long timeout, TimeUnit unit) boolean
void
void
void
int
take()
takeLast()
Methods inherited from class com.google.common.collect.ForwardingDeque
addFirst, addLast, descendingIterator, getFirst, getLast, offerFirst, offerLast, peekFirst, peekLast, pollFirst, pollLast, pop, push, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence
Methods inherited from class com.google.common.collect.ForwardingQueue
element, offer, peek, poll, remove, standardOffer, standardPeek, standardPoll
Methods inherited from class com.google.common.collect.ForwardingCollection
add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, standardAddAll, standardClear, standardContains, standardContainsAll, standardIsEmpty, standardRemove, standardRemoveAll, standardRetainAll, standardToArray, standardToArray, standardToString, toArray, toArray
Methods inherited from class com.google.common.collect.ForwardingObject
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.concurrent.BlockingDeque
add, addFirst, addLast, contains, element, iterator, offer, offerFirst, offerLast, peek, poll, push, remove, remove, removeFirstOccurrence, removeLastOccurrence, size
Methods inherited from interface java.util.Collection
clear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray, toArray
-
Constructor Details
-
ForwardingBlockingDeque
protected ForwardingBlockingDeque()Constructor for use by subclasses.
-
-
Method Details
-
delegate
Description copied from class:ForwardingObject
Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such asForwardingSet.delegate()
. Concrete subclasses override this method to supply the instance being decorated.- Specified by:
delegate
in classForwardingDeque<E>
-
remainingCapacity
- Specified by:
remainingCapacity
in interfaceBlockingQueue<E>
-
putFirst
- Specified by:
putFirst
in interfaceBlockingDeque<E>
- Throws:
InterruptedException
-
putLast
- Specified by:
putLast
in interfaceBlockingDeque<E>
- Throws:
InterruptedException
-
offerFirst
- Specified by:
offerFirst
in interfaceBlockingDeque<E>
- Throws:
InterruptedException
-
offerLast
- Specified by:
offerLast
in interfaceBlockingDeque<E>
- Throws:
InterruptedException
-
takeFirst
- Specified by:
takeFirst
in interfaceBlockingDeque<E>
- Throws:
InterruptedException
-
takeLast
- Specified by:
takeLast
in interfaceBlockingDeque<E>
- Throws:
InterruptedException
-
pollFirst
- Specified by:
pollFirst
in interfaceBlockingDeque<E>
- Throws:
InterruptedException
-
pollLast
- Specified by:
pollLast
in interfaceBlockingDeque<E>
- Throws:
InterruptedException
-
put
- Specified by:
put
in interfaceBlockingDeque<E>
- Specified by:
put
in interfaceBlockingQueue<E>
- Throws:
InterruptedException
-
offer
- Specified by:
offer
in interfaceBlockingDeque<E>
- Specified by:
offer
in interfaceBlockingQueue<E>
- Throws:
InterruptedException
-
take
- Specified by:
take
in interfaceBlockingDeque<E>
- Specified by:
take
in interfaceBlockingQueue<E>
- Throws:
InterruptedException
-
poll
- Specified by:
poll
in interfaceBlockingDeque<E>
- Specified by:
poll
in interfaceBlockingQueue<E>
- Throws:
InterruptedException
-
drainTo
- Specified by:
drainTo
in interfaceBlockingQueue<E>
-
drainTo
- Specified by:
drainTo
in interfaceBlockingQueue<E>
-