Package com.google.common.collect

Class ForwardingDeque<E extends @Nullable 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:

Iterable<E>, Collection<E>, Deque<E>, Queue<E>

Direct Known Subclasses:

ForwardingBlockingDeque, ForwardingBlockingDeque

@GwtIncompatible
public abstract class ForwardingDeque<E extends @Nullable Object>
extends ForwardingQueue<E>
implements 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, overriding ForwardingCollection.add(E) alone will not change the behavior of ForwardingQueue.offer(E) which can lead to unexpected behavior. In this case, you should override offer as well.

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 ForwardingDeque.

Since:

12.0

Author:

Kurt Alfred Kluever

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ForwardingDeque()	Constructor for use by subclasses.

Method Summary

Modifier and Type	Method	Description
void	addFirst(E e)
void	addLast(E e)
protected abstract Deque<E>	delegate()	Returns the backing delegate instance that methods are forwarded to.
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(Object o)
E	removeLast()
boolean	removeLastOccurrence(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

Methods inherited from interface java.util.Deque

add, addAll, contains, element, iterator, offer, peek, poll, remove, remove, size

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ForwardingDeque

protected ForwardingDeque()

Constructor for use by subclasses.

Method Detail

delegate

protected abstract 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 as ForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.

Specified by:

delegate in class ForwardingQueue<E extends @Nullable Object>

addFirst

public void addFirst(E e)

Specified by:

addFirst in interface Deque<E extends @Nullable Object>

addLast

public void addLast(E e)

Specified by:

addLast in interface Deque<E extends @Nullable Object>

descendingIterator

public Iterator<E> descendingIterator()

Specified by:

descendingIterator in interface Deque<E extends @Nullable Object>

getFirst

public E getFirst()

Specified by:

getFirst in interface Deque<E extends @Nullable Object>

getLast

public E getLast()

Specified by:

getLast in interface Deque<E extends @Nullable Object>

offerFirst

@CanIgnoreReturnValue
public boolean offerFirst(E e)

Specified by:

offerFirst in interface Deque<E extends @Nullable Object>

offerLast

@CanIgnoreReturnValue
public boolean offerLast(E e)

Specified by:

offerLast in interface Deque<E extends @Nullable Object>

peekFirst

@CheckForNull
public E peekFirst()

Specified by:

peekFirst in interface Deque<E extends @Nullable Object>

peekLast

@CheckForNull
public E peekLast()

Specified by:

peekLast in interface Deque<E extends @Nullable Object>

pollFirst

@CanIgnoreReturnValue
@CheckForNull
public E pollFirst()

Specified by:

pollFirst in interface Deque<E extends @Nullable Object>

pollLast

@CanIgnoreReturnValue
@CheckForNull
public E pollLast()

Specified by:

pollLast in interface Deque<E extends @Nullable Object>

pop

@CanIgnoreReturnValue
public E pop()

Specified by:

pop in interface Deque<E extends @Nullable Object>

push

public void push(E e)

Specified by:

push in interface Deque<E extends @Nullable Object>

removeFirst

@CanIgnoreReturnValue
public E removeFirst()

Specified by:

removeFirst in interface Deque<E extends @Nullable Object>

removeLast

@CanIgnoreReturnValue
public E removeLast()

Specified by:

removeLast in interface Deque<E extends @Nullable Object>

removeFirstOccurrence

@CanIgnoreReturnValue
public boolean removeFirstOccurrence(@CheckForNull
                                     Object o)

Specified by:

removeFirstOccurrence in interface Deque<E extends @Nullable Object>

removeLastOccurrence

@CanIgnoreReturnValue
public boolean removeLastOccurrence(@CheckForNull
                                    Object o)

Specified by:

removeLastOccurrence in interface Deque<E extends @Nullable Object>