Package com.google.common.collect

Class ForwardingDeque<E extends @Nullable java.lang.Object>

  • 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, 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 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 as ForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.
        Specified by:
        delegate in class ForwardingQueue<E extends @Nullable java.lang.Object>

      • addFirst

        public void addFirst​(E e)
        Specified by:
        addFirst in interface java.util.Deque<E extends @Nullable java.lang.Object>

      • addLast

        public void addLast​(E e)
        Specified by:
        addLast in interface java.util.Deque<E extends @Nullable java.lang.Object>

      • descendingIterator

        public java.util.Iterator<E> descendingIterator()
        Specified by:
        descendingIterator in interface java.util.Deque<E extends @Nullable java.lang.Object>

      • getFirst

        public E getFirst()
        Specified by:
        getFirst in interface java.util.Deque<E extends @Nullable java.lang.Object>

      • getLast

        public E getLast()
        Specified by:
        getLast in interface java.util.Deque<E extends @Nullable java.lang.Object>

      • offerFirst

        @CanIgnoreReturnValue
public boolean offerFirst​(E e)
        Specified by:
        offerFirst in interface java.util.Deque<E extends @Nullable java.lang.Object>

      • offerLast

        @CanIgnoreReturnValue
public boolean offerLast​(E e)
        Specified by:
        offerLast in interface java.util.Deque<E extends @Nullable java.lang.Object>

      • peekFirst

        @CheckForNull
public E peekFirst()
        Specified by:
        peekFirst in interface java.util.Deque<E extends @Nullable java.lang.Object>

      • peekLast

        @CheckForNull
public E peekLast()
        Specified by:
        peekLast in interface java.util.Deque<E extends @Nullable java.lang.Object>

      • pollFirst

        @CanIgnoreReturnValue
@CheckForNull
public E pollFirst()
        Specified by:
        pollFirst in interface java.util.Deque<E extends @Nullable java.lang.Object>

      • pollLast

        @CanIgnoreReturnValue
@CheckForNull
public E pollLast()
        Specified by:
        pollLast in interface java.util.Deque<E extends @Nullable java.lang.Object>

      • pop

        @CanIgnoreReturnValue
public E pop()
        Specified by:
        pop in interface java.util.Deque<E extends @Nullable java.lang.Object>

      • push

        public void push​(E e)
        Specified by:
        push in interface java.util.Deque<E extends @Nullable java.lang.Object>

      • removeFirst

        @CanIgnoreReturnValue
public E removeFirst()
        Specified by:
        removeFirst in interface java.util.Deque<E extends @Nullable java.lang.Object>

      • removeLast

        @CanIgnoreReturnValue
public E removeLast()
        Specified by:
        removeLast in interface java.util.Deque<E extends @Nullable java.lang.Object>

      • removeFirstOccurrence

        @CanIgnoreReturnValue
public boolean removeFirstOccurrence​(@CheckForNull
                                     java.lang.Object o)
        Specified by:
        removeFirstOccurrence in interface java.util.Deque<E extends @Nullable java.lang.Object>

      • removeLastOccurrence

        @CanIgnoreReturnValue
public boolean removeLastOccurrence​(@CheckForNull
                                    java.lang.Object o)
        Specified by:
        removeLastOccurrence in interface java.util.Deque<E extends @Nullable java.lang.Object>