Package com.google.common.collect
Class ForwardingDeque<E extends @Nullable java.lang.Object>
- java.lang.Object
-
- com.google.common.collect.ForwardingObject
-
- com.google.common.collect.ForwardingCollection<E>
-
- com.google.common.collect.ForwardingQueue<E>
-
- com.google.common.collect.ForwardingDeque<E>
-
- All Implemented Interfaces:
java.lang.Iterable<E>
,java.util.Collection<E>
,java.util.Deque<E>
,java.util.Queue<E>
- Direct Known Subclasses:
ForwardingBlockingDeque
,ForwardingBlockingDeque
@GwtIncompatible public abstract class ForwardingDeque<E extends @Nullable java.lang.Object> extends ForwardingQueue<E> implements java.util.Deque<E>
A deque which forwards all its method calls to another deque. 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
ForwardingDeque
forward indiscriminately to the methods of the delegate. For example, overridingForwardingCollection.add(E)
alone will not change the behavior ofForwardingQueue.offer(E)
which can lead to unexpected behavior. In this case, you should overrideoffer
as well.default
method warning: This class does not forward calls todefault
methods. Instead, it inherits their default implementations. When those implementations invoke methods, they invoke methods on theForwardingDeque
.- Since:
- 12.0
- Author:
- Kurt Alfred Kluever
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ForwardingDeque()
Constructor for use by subclasses.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
addFirst(E e)
void
addLast(E e)
protected abstract java.util.Deque<E>
delegate()
Returns the backing delegate instance that methods are forwarded to.java.util.Iterator<E>
descendingIterator()
E
getFirst()
E
getLast()
boolean
offerFirst(E e)
boolean
offerLast(E e)
E
peekFirst()
E
peekLast()
E
pollFirst()
E
pollLast()
E
pop()
void
push(E e)
E
removeFirst()
boolean
removeFirstOccurrence(java.lang.Object o)
E
removeLast()
boolean
removeLastOccurrence(java.lang.Object o)
-
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.Collection
clear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray, toArray
-
-
-
-
Constructor Detail
-
ForwardingDeque
protected ForwardingDeque()
Constructor for use by subclasses.
-
-
Method Detail
-
delegate
protected abstract java.util.Deque<E> 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 classForwardingQueue<E extends @Nullable java.lang.Object>
-
descendingIterator
public java.util.Iterator<E> descendingIterator()
-
offerFirst
@CanIgnoreReturnValue public boolean offerFirst(E e)
-
offerLast
@CanIgnoreReturnValue public boolean offerLast(E e)
-
peekFirst
@CheckForNull public E peekFirst()
-
peekLast
@CheckForNull public E peekLast()
-
pollFirst
@CanIgnoreReturnValue @CheckForNull public E pollFirst()
-
pollLast
@CanIgnoreReturnValue @CheckForNull public E pollLast()
-
pop
@CanIgnoreReturnValue public E pop()
-
removeFirst
@CanIgnoreReturnValue public E removeFirst()
-
removeLast
@CanIgnoreReturnValue public E removeLast()
-
removeFirstOccurrence
@CanIgnoreReturnValue public boolean removeFirstOccurrence(@CheckForNull java.lang.Object o)
-
removeLastOccurrence
@CanIgnoreReturnValue public boolean removeLastOccurrence(@CheckForNull java.lang.Object o)
-
-