mongo-java-driver/src/main/com/mongodb/Deque.java at r2.12.2 · dev4java/mongo-java-driver

460 lines (428 loc) · 16.6 KB
 * Copyright (c) 2008-2014 MongoDB, Inc.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *   http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * Written by Doug Lea and Josh Bloch with assistance from members of
 * JCP JSR-166 Expert Group and released to the public domain, as explained
 * at http://creativecommons.org/publicdomain/zero/1.0/
package com.mongodb;
import java.util.Iterator;
import java.util.Queue;
 * A linear collection that supports element insertion and removal at
 * both ends.  The name <i>deque</i> is short for "double ended queue"
 * and is usually pronounced "deck".  Most {@code Deque}
 * implementations place no fixed limits on the number of elements
 * they may contain, but this interface supports capacity-restricted
 * deques as well as those with no fixed size limit.
 * <p>This interface defines methods to access the elements at both
 * ends of the deque.  Methods are provided to insert, remove, and
 * examine the element.  Each of these methods exists in two forms:
 * one throws an exception if the operation fails, the other returns a
 * special value (either {@code null} or {@code false}, depending on
 * the operation).  The latter form of the insert operation is
 * designed specifically for use with capacity-restricted
 * {@code Deque} implementations; in most implementations, insert
 * operations cannot fail.
 * <p>The twelve methods described above are summarized in the
 * following table:<p>
 * <table BORDER CELLPADDING=3 CELLSPACING=1>
 *    <td></td>
 *    <td ALIGN=CENTER COLSPAN = 2> <b>First Element (Head)</b></td>
 *    <td ALIGN=CENTER COLSPAN = 2> <b>Last Element (Tail)</b></td>
 *    <td></td>
 *    <td ALIGN=CENTER><em>Throws exception</em></td>
 *    <td ALIGN=CENTER><em>Returns special value</em></td>
 *    <td ALIGN=CENTER><em>Throws exception</em></td>
 *    <td ALIGN=CENTER><em>Returns special value</em></td>
 *    <td><b>Insert</b></td>
 *    <td>{@link #addFirst addFirst(e)}</td>
 *    <td>{@link #offerFirst offerFirst(e)}</td>
 *    <td>{@link #addLast addLast(e)}</td>
 *    <td>{@link #offerLast offerLast(e)}</td>
 *    <td><b>Remove</b></td>
 *    <td>{@link #removeFirst removeFirst()}</td>
 *    <td>{@link #pollFirst pollFirst()}</td>
 *    <td>{@link #removeLast removeLast()}</td>
 *    <td>{@link #pollLast pollLast()}</td>
 *    <td><b>Examine</b></td>
 *    <td>{@link #getFirst getFirst()}</td>
 *    <td>{@link #peekFirst peekFirst()}</td>
 *    <td>{@link #getLast getLast()}</td>
 *    <td>{@link #peekLast peekLast()}</td>
 * </table>
 * <p>This interface extends the {@link Queue} interface.  When a deque is
 * used as a queue, FIFO (First-In-First-Out) behavior results.  Elements are
 * added to the end of the deque and removed from the beginning.  The methods
 * inherited from the {@code Queue} interface are precisely equivalent to
 * {@code Deque} methods as indicated in the following table:<p>
 * <table BORDER CELLPADDING=3 CELLSPACING=1>
 *    <td ALIGN=CENTER> <b>{@code Queue} Method</b></td>
 *    <td ALIGN=CENTER> <b>Equivalent {@code Deque} Method</b></td>
 *    <td>{@link java.util.Queue#offer offer(e)}</td>
 *    <td>{@link #offerLast offerLast(e)}</td>
 *    <td>{@link java.util.Queue#add add(e)}</td>
 *    <td>{@link #addLast addLast(e)}</td>
 *    <td>{@link java.util.Queue#poll poll()}</td>
 *    <td>{@link #pollFirst pollFirst()}</td>
 *    <td>{@link java.util.Queue#remove remove()}</td>
 *    <td>{@link #removeFirst removeFirst()}</td>
 *    <td>{@link java.util.Queue#peek peek()}</td>
 *    <td>{@link #peek peekFirst()}</td>
 *    <td>{@link java.util.Queue#element element()}</td>
 *    <td>{@link #getFirst getFirst()}</td>
 * </table>
 * <p>Deques can also be used as LIFO (Last-In-First-Out) stacks.  This
 * interface should be used in preference to the legacy {@link java.util.Stack} class.
 * When a dequeue is used as a stack, elements are pushed and popped from the
 * beginning of the deque.  Stack methods are precisely equivalent to
 * {@code Deque} methods as indicated in the table below:<p>
 * <table BORDER CELLPADDING=3 CELLSPACING=1>
 *    <td ALIGN=CENTER> <b>Stack Method</b></td>
 *    <td ALIGN=CENTER> <b>Equivalent {@code Deque} Method</b></td>
 *    <td>{@link #push push(e)}</td>
 *    <td>{@link #addFirst addFirst(e)}</td>
 *    <td>{@link #pop pop()}</td>
 *    <td>{@link #removeFirst removeFirst()}</td>
 *    <td>{@link #peek peek()}</td>
 *    <td>{@link #peekFirst peekFirst()}</td>
 * </table>
 * <p>Note that the {@link #peek peek} method works equally well when
 * a deque is used as a queue or a stack; in either case, elements are
 * drawn from the beginning of the deque.
 * <p>This interface provides two methods to remove interior
 * elements, {@link #removeFirstOccurrence removeFirstOccurrence} and
 * {@link #removeLastOccurrence removeLastOccurrence}.  Unlike the
 * {@link java.util.List} interface, this interface does not provide support for
 * indexed access to elements.
 * <p>While {@code Deque} implementations are not strictly required
 * to prohibit the insertion of null elements, they are strongly
 * encouraged to do so.  Users of any {@code Deque} implementations
 * that do allow null elements are strongly encouraged <i>not</i> to
 * take advantage of the ability to insert nulls.  This is so because
 * {@code null} is used as a special return value by various methods
 * to indicated that the deque is empty.
 * <p>{@code Deque} implementations generally do not define
 * element-based versions of the {@code equals} and {@code hashCode}
 * methods, but instead inherit the identity-based versions from class
 * {@code Object}.
 * <p>This interface is a member of the <a
 * href="{@docRoot}/../guide/collections/index.html"> Java Collections
 * Framework</a>.
 * @author Doug Lea
 * @author Josh Bloch
 * @since  1.6
 * @param <E> the type of elements held in this collection
interface Deque<E> extends Queue<E> {
     * Inserts the specified element to the front this deque unless it would
     * violate capacity restrictions.  When using a capacity-restricted deque,
     * this method is generally preferable to method {@code addFirst}, which
     * can fail to insert an element only by throwing an exception.
     * @param e the element to insert
     * @return {@code true} if it was possible to insert the element,
     *     else {@code false}
     * @throws NullPointerException if {@code e} is null and this
     *     deque does not permit null elements
    boolean offerFirst(E e);
     * Inserts the specified element to the end of this deque unless it would
     * violate capacity restrictions.  When using a capacity-restricted deque,
     * this method is generally preferable to method {@code addLast} which
     * can fail to insert an element only by throwing an exception.
     * @param e the element to insert
     * @return {@code true} if it was possible to insert the element,
     *     else {@code false}
     * @throws NullPointerException if {@code e} is null and this
     *     deque does not permit null elements
    boolean offerLast(E e);
     * Inserts the specified element to the front of this deque unless it
     * would violate capacity restrictions.
     * @param e the element to insert
     * @throws IllegalStateException if it was not possible to insert
     *    the element due to capacity restrictions
     * @throws NullPointerException if {@code e} is null and this
     *     deque does not permit null elements
    void addFirst(E e);
     * Inserts the specified element to the end of this deque unless it would
     * violate capacity restrictions.
     * @param e the element to insert
     * @throws IllegalStateException if it was not possible to insert
     *    the element due to capacity restrictions
     * @throws NullPointerException if {@code e} is null and this
     *     deque does not permit null elements
    void addLast(E e);
     * Retrieves and removes the first element of this deque, or
     * {@code null} if this deque is empty.
     * @return the first element of this deque, or {@code null} if
     *     this deque is empty
    E pollFirst();
     * Retrieves and removes the last element of this deque, or
     * {@code null} if this deque is empty.
     * @return the last element of this deque, or {@code null} if
     *     this deque is empty
    E pollLast();
     * Removes and returns the first element of this deque.  This method
     * differs from the {@code pollFirst} method only in that it throws an
     * exception if this deque is empty.
     * @return the first element of this deque
     * @throws java.util.NoSuchElementException if this deque is empty
    E removeFirst();
     * Retrieves and removes the last element of this deque.  This method
     * differs from the {@code pollLast} method only in that it throws an
     * exception if this deque is empty.
     * @return the last element of this deque
     * @throws java.util.NoSuchElementException if this deque is empty
    E removeLast();
     * Retrieves, but does not remove, the first element of this deque,
     * returning {@code null} if this deque is empty.
     * @return the first element of this deque, or {@code null} if
     *     this deque is empty
    E peekFirst();
     * Retrieves, but does not remove, the last element of this deque,
     * returning {@code null} if this deque is empty.
     * @return the last element of this deque, or {@code null} if this deque
     *     is empty
    E peekLast();
     * Retrieves, but does not remove, the first element of this
     * deque.  This method differs from the {@code peek} method only
     * in that it throws an exception if this deque is empty.
     * @return the first element of this deque
     * @throws java.util.NoSuchElementException if this deque is empty
    E getFirst();
     * Retrieves, but does not remove, the last element of this
     * deque.  This method differs from the {@code peek} method only
     * in that it throws an exception if this deque is empty.
     * @return the last element of this deque
     * @throws java.util.NoSuchElementException if this deque is empty
    E getLast();
     * Removes the first occurrence of the specified element in this
     * deque.  If the deque does not contain the element, it is
     * unchanged.  More formally, removes the first element {@code e}
     * such that {@code (o==null ? e==null : o.equals(e))} (if
     * such an element exists).
     * @param e element to be removed from this deque, if present
     * @return {@code true} if the deque contained the specified element
     * @throws NullPointerException if the specified element is {@code null}
    boolean removeFirstOccurrence(Object e);
     * Removes the last occurrence of the specified element in this
     * deque.  If the deque does not contain the element, it is
     * unchanged.  More formally, removes the last element {@code e}
     * such that {@code (o==null ? e==null : o.equals(e))} (if
     * such an element exists).
     * @param e element to be removed from this deque, if present
     * @return {@code true} if the deque contained the specified element
     * @throws NullPointerException if the specified element is {@code null}
    boolean removeLastOccurrence(Object e);
    // *** Queue methods ***
     * Inserts the specified element into the queue represented by this deque
     * unless it would violate capacity restrictions.  In other words, inserts
     * the specified element to the end of this deque.  When using a
     * capacity-restricted deque, this method is generally preferable to the
     * {@link #add} method, which can fail to insert an element only by
     * throwing an exception.
     * <p>This method is equivalent to {@link #offerLast}.
     * @param e the element to insert
     * @return {@code true} if it was possible to insert the element,
     *     else {@code false}
     * @throws NullPointerException if {@code e} is null and this
     *     deque does not permit null elements
    boolean offer(E e);
     * Inserts the specified element into the queue represented by this
     * deque unless it would violate capacity restrictions.  In other words,
     * inserts the specified element as the last element of this deque.
     * <p>This method is equivalent to {@link #addLast}.
     * @param e the element to insert
     * @return {@code true} (as per the spec for {@link java.util.Collection#add})
     * @throws IllegalStateException if it was not possible to insert
     *    the element due to capacity restrictions
     * @throws NullPointerException if {@code e} is null and this
     *     deque does not permit null elements
    boolean add(E e);
     * Retrieves and removes the head of the queue represented by
     * this deque, or {@code null} if this deque is empty.  In other words,
     * retrieves and removes the first element of this deque, or {@code null}
     * if this deque is empty.
     * <p>This method is equivalent to {@link #pollFirst()}.
     * @return the first element of this deque, or {@code null} if
     *     this deque is empty
    E poll();
     * Retrieves and removes the head of the queue represented by this deque.
     * This method differs from the {@code poll} method only in that it
     * throws an exception if this deque is empty.
     * <p>This method is equivalent to {@link #removeFirst()}.
     * @return the head of the queue represented by this deque
     * @throws java.util.NoSuchElementException if this deque is empty
    E remove();
     * Retrieves, but does not remove, the head of the queue represented by
     * this deque, returning {@code null} if this deque is empty.
     * <p>This method is equivalent to {@link #peekFirst()}.
     * @return the head of the queue represented by this deque, or
     *     {@code null} if this deque is empty
    E peek();
     * Retrieves, but does not remove, the head of the queue represented by
     * this deque.  This method differs from the {@code peek} method only in
     * that it throws an exception if this deque is empty.
     * <p>This method is equivalent to {@link #getFirst()}.
     * @return the head of the queue represented by this deque
     * @throws java.util.NoSuchElementException if this deque is empty
    E element();
    // *** Stack methods ***
     * Pushes an element onto the stack represented by this deque.  In other
     * words, inserts the element to the front this deque unless it would
     * violate capacity restrictions.
     * <p>This method is equivalent to {@link #addFirst}.
     * @throws IllegalStateException if it was not possible to insert
     *    the element due to capacity restrictions
     * @throws NullPointerException if {@code e} is null and this
     *     deque does not permit null elements
    void push(E e);
     * Pops an element from the stack represented by this deque.  In other
     * words, removes and returns the first element of this deque.
     * <p>This method is equivalent to {@link #removeFirst()}.
     * @return the element at the front of this deque (which is the top
     *     of the stack represented by this deque)
     * @throws java.util.NoSuchElementException if this deque is empty
    E pop();
    // *** Collection Method ***
     * Returns an iterator over the elements in this deque.  The elements
     * will be ordered from first (head) to last (tail).
     * @return an {@code Iterator} over the elements in this deque
    Iterator<E> iterator();
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

Deque.java

Latest commit

History

Deque.java

File metadata and controls
