com.xenoamess.commons.primitive.collections.queues.BooleanDeque Maven / Gradle / Ivy
Show all versions of commonx Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* This file is available under and governed by the GNU General Public
* License version 2 only, as published by the Free Software Foundation.
* However, the following notice accompanied the original version of this
* file:
*
* 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.xenoamess.commons.primitive.collections.queues;
import com.xenoamess.commons.primitive.Primitive;
import com.xenoamess.commons.primitive.collections.lists.BooleanList;
import com.xenoamess.commons.primitive.iterators.BooleanIterator;
import java.util.Collection;
import java.util.Deque;
import java.util.NoSuchElementException;
import java.util.Stack;
/**
* A linear collection that supports element insertion and removal at
* both ends. The name deque is short for "boolean 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.
*
* 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.
*
*
The twelve methods described above are summarized in the
* following table:
*
*
* Summary of Deque methods
*
*
* First Element (Head)
* Last Element (Tail)
*
*
* Throws exception
* Special value
* Throws exception
* Special value
*
*
*
*
* Insert
* {@link #addFirst(Boolean) addFirst(e)}
* {@link #offerFirst(Boolean) offerFirst(e)}
* {@link #addLast(Boolean) addLast(e)}
* {@link #offerLast(Boolean) offerLast(e)}
*
*
* Remove
* {@link #removeFirst() removeFirst()}
* {@link #pollFirst() pollFirst()}
* {@link #removeLast() removeLast()}
* {@link #pollLast() pollLast()}
*
*
* Examine
* {@link #getFirst() getFirst()}
* {@link #peekFirst() peekFirst()}
* {@link #getLast() getLast()}
* {@link #peekLast() peekLast()}
*
*
*
*
* This interface extends the {@link BooleanQueue} interface. When a deque is
* used as a queue, FIFO (First-In-First-Out) behavior results. Elements are
* added at 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:
*
*
* Comparison of Queue and Deque methods
*
*
* {@code Queue} Method
* Equivalent {@code Deque} Method
*
*
*
*
* {@link #add(Boolean) add(e)}
* {@link #addLast(Boolean) addLast(e)}
*
*
* {@link #offer(Boolean) offer(e)}
* {@link #offerLast(Boolean) offerLast(e)}
*
*
* {@link #remove() remove()}
* {@link #removeFirst() removeFirst()}
*
*
* {@link #poll() poll()}
* {@link #pollFirst() pollFirst()}
*
*
* {@link #element() element()}
* {@link #getFirst() getFirst()}
*
*
* {@link #peek() peek()}
* {@link #peekFirst() peekFirst()}
*
*
*
*
* Deques can also be used as LIFO (Last-In-First-Out) stacks. This
* interface should be used in preference to the legacy {@link Stack} class.
* When a deque is used as a stack, elements are pushed and popped from the
* beginning of the deque. Stack methods are equivalent to {@code Deque}
* methods as indicated in the table below:
*
*
* Comparison of Stack and Deque methods
*
*
* Stack Method
* Equivalent {@code Deque} Method
*
*
*
*
* {@link #push(Boolean) push(e)}
* {@link #addFirst(Boolean) addFirst(e)}
*
*
* {@link #pop() pop()}
* {@link #removeFirst() removeFirst()}
*
*
* {@link #peek() peek()}
* {@link #getFirst() getFirst()}
*
*
*
*
* 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.
*
*
This interface provides two methods to remove interior
* elements, {@link #removeFirstOccurrence removeFirstOccurrence} and
* {@link #removeLastOccurrence removeLastOccurrence}.
*
*
Unlike the {@link BooleanList} interface, this interface does not
* provide support for indexed access to elements.
*
*
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 not 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 indicate that the deque is empty.
*
*
{@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}.
*
*
This interface is a member of the
*
* Java Collections Framework.
*
* @author Doug Lea
* @author Josh Bloch
* @since 1.6
*/
public interface BooleanDeque extends Deque, BooleanQueue, Primitive {
/**
* Inserts the specified element at the front of this deque if it is
* possible to do so immediately without violating capacity restrictions,
* throwing an {@code IllegalStateException} if no space is currently
* available. When using a capacity-restricted deque, it is generally
* preferable to use method {@link #offerFirst}.
*
* @param e the element to add
* @throws IllegalStateException if the element cannot be added at this
* time due to capacity restrictions
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @throws IllegalArgumentException if some property of the specified
* element prevents it from being added to this deque
*/
@Override
default void addFirst(Boolean e) {
this.addFirstPrimitive(e);
}
/**
* Primitive replacement of addFirst(Boolean e)
*
* @param e the element to add
* @throws IllegalStateException if the element cannot be added at this
* time due to capacity restrictions
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @throws IllegalArgumentException if some property of the specified
* element prevents it from being added to this deque
* @see #addFirst(Boolean e)
*/
default void addFirst(boolean e) {
this.addFirstPrimitive(e);
}
/**
* Primitive replacement of addFirst(Boolean e)
*
* @param e the element to add
* @throws IllegalStateException if the element cannot be added at this
* time due to capacity restrictions
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @throws IllegalArgumentException if some property of the specified
* element prevents it from being added to this deque
* @see #addFirst(Boolean e)
*/
void addFirstPrimitive(boolean e);
/**
* Inserts the specified element at the end of this deque if it is
* possible to do so immediately without violating capacity restrictions,
* throwing an {@code IllegalStateException} if no space is currently
* available. When using a capacity-restricted deque, it is generally
* preferable to use method {@link #offerLast}.
*
* This method is equivalent to {@link #add}.
*
* @param e the element to add
* @throws IllegalStateException if the element cannot be added at this
* time due to capacity restrictions
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @throws IllegalArgumentException if some property of the specified
* element prevents it from being added to this deque
*/
@Override
default void addLast(Boolean e) {
this.addLastPrimitive(e);
}
/**
* Primitive replacement of addLast(Boolean e)
*
* @param e the element to add
* @throws IllegalStateException if the element cannot be added at this
* time due to capacity restrictions
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @throws IllegalArgumentException if some property of the specified
* element prevents it from being added to this deque
* @see #addLast(Boolean e)
*/
default void addLast(boolean e) {
this.addLastPrimitive(e);
}
/**
* Primitive replacement of addLast(Boolean e)
*
* @param e the element to add
* @throws IllegalStateException if the element cannot be added at this
* time due to capacity restrictions
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @throws IllegalArgumentException if some property of the specified
* element prevents it from being added to this deque
* @see #addLast(Boolean e)
*/
void addLastPrimitive(boolean e);
/**
* Inserts the specified element at the front of this deque unless it would
* violate capacity restrictions. When using a capacity-restricted deque,
* this method is generally preferable to the {@link #addFirst} method,
* which can fail to insert an element only by throwing an exception.
*
* @param e the element to add
* @return {@code true} if the element was added to this deque, else
* {@code false}
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @throws IllegalArgumentException if some property of the specified
* element prevents it from being added to this deque
*/
@Override
default boolean offerFirst(Boolean e) {
return this.offerFirstPrimitive(e);
}
/**
* Primitive replacement of offerFirst(Boolean e)
*
* @param e the element to add
* @return {@code true} if the element was added to this deque, else
* {@code false}
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @throws IllegalArgumentException if some property of the specified
* element prevents it from being added to this deque
* @see #offerFirst(Boolean e)
*/
default boolean offerFirst(boolean e) {
return this.offerFirstPrimitive(e);
}
/**
* Primitive replacement of offerFirst(Boolean e)
*
* @param e the element to add
* @return {@code true} if the element was added to this deque, else
* {@code false}
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @throws IllegalArgumentException if some property of the specified
* element prevents it from being added to this deque
* @see #offerFirst(Boolean e)
*/
boolean offerFirstPrimitive(boolean e);
/**
* Inserts the specified element at the end of this deque unless it would
* violate capacity restrictions. When using a capacity-restricted deque,
* this method is generally preferable to the {@link #addLast} method,
* which can fail to insert an element only by throwing an exception.
*
* @param e the element to add
* @return {@code true} if the element was added to this deque, else
* {@code false}
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @throws IllegalArgumentException if some property of the specified
* element prevents it from being added to this deque
*/
@Override
default boolean offerLast(Boolean e) {
return this.offerLastPrimitive(e);
}
/**
* Primitive replacement of offerLast(Boolean e)
*
* @param e the element to add
* @return {@code true} if the element was added to this deque, else
* {@code false}
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @throws IllegalArgumentException if some property of the specified
* element prevents it from being added to this deque
* @see #offerLast(Boolean e)
*/
default boolean offerLast(boolean e) {
return this.offerLastPrimitive(e);
}
/**
* Primitive replacement of offerLast(Boolean e)
*
* @param e the element to add
* @return {@code true} if the element was added to this deque, else
* {@code false}
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @throws IllegalArgumentException if some property of the specified
* element prevents it from being added to this deque
* @see #offerLast(Boolean e)
*/
boolean offerLastPrimitive(boolean e);
/**
* Retrieves and removes the first element of this deque. This method
* differs from {@link #pollFirst pollFirst} only in that it throws an
* exception if this deque is empty.
*
* @return the head of this deque
* @throws NoSuchElementException if this deque is empty
*/
@Override
default Boolean removeFirst() {
return removeFirstPrimitive();
}
/**
* Primitive replacement of removeFirst()
*
* @return the head of this deque
* @throws NoSuchElementException if this deque is empty
* @see #removeFirst()
*/
boolean removeFirstPrimitive();
/**
* Retrieves and removes the last element of this deque. This method
* differs from {@link #pollLast pollLast} only in that it throws an
* exception if this deque is empty.
*
* @return the tail of this deque
* @throws NoSuchElementException if this deque is empty
*/
@Override
default Boolean removeLast() {
return removeLastPrimitive();
}
/**
* Primitive replacement of removeLast()
*
* @return the tail of this deque
* @throws NoSuchElementException if this deque is empty
* @see #removeLast()
*/
boolean removeLastPrimitive();
/**
* Retrieves and removes the first element of this deque,
* or returns {@code null} if this deque is empty.
*
* @return the head of this deque, or {@code null} if this deque is empty
*/
@Override
default Boolean pollFirst() {
return this.pollFirstPrimitive();
}
/**
* Primitive replacement of pollFirst()
*
* @return the head of this deque, or {@code null} if this deque is empty
* @see #pollFirst()
*/
boolean pollFirstPrimitive();
/**
* Retrieves and removes the last element of this deque,
* or returns {@code null} if this deque is empty.
*
* @return the tail of this deque, or {@code null} if this deque is empty
*/
@Override
default Boolean pollLast() {
return this.pollLastPrimitive();
}
/**
* Primitive replacement of pollLast()
*
* @return the tail of this deque, or {@code null} if this deque is empty
* @see #pollLast()
*/
boolean pollLastPrimitive();
/**
* Retrieves, but does not remove, the first element of this deque.
*
* This method differs from {@link #peekFirst peekFirst} only in that it
* throws an exception if this deque is empty.
*
* @return the head of this deque
* @throws NoSuchElementException if this deque is empty
*/
@Override
default Boolean getFirst() {
return this.getFirstPrimitive();
}
/**
* Primitive replacement of getFirst()
*
* @return the head of this deque
* @throws NoSuchElementException if this deque is empty
* @see #getFirst()
*/
boolean getFirstPrimitive();
/**
* Retrieves, but does not remove, the last element of this deque.
* This method differs from {@link #peekLast peekLast} only in that it
* throws an exception if this deque is empty.
*
* @return the tail of this deque
* @throws NoSuchElementException if this deque is empty
*/
@Override
default Boolean getLast() {
return this.getLastPrimitive();
}
/**
* Primitive replacement of getLast()
*
* @return the tail of this deque
* @throws NoSuchElementException if this deque is empty
* @see #getLast()
*/
boolean getLastPrimitive();
/**
* Retrieves, but does not remove, the first element of this deque,
* or returns {@code null} if this deque is empty.
*
* @return the head of this deque, or {@code null} if this deque is empty
*/
@Override
default Boolean peekFirst() {
return this.peekFirstPrimitive();
}
/**
* Primitive replacement of peekFirst()
*
* @return the head of this deque, or {@code null} if this deque is empty
* @see #peekFirst()
*/
boolean peekFirstPrimitive();
/**
* Retrieves, but does not remove, the last element of this deque,
* or returns {@code null} if this deque is empty.
*
* @return the tail of this deque, or {@code null} if this deque is empty
*/
@Override
default Boolean peekLast() {
return this.peekLastPrimitive();
}
/**
* Primitive replacement of peekLast()
*
* @return the tail of this deque, or {@code null} if this deque is empty
* @see #peekLast()
*/
boolean peekLastPrimitive();
/**
* Removes the first occurrence of the specified element from this deque.
* If the deque does not contain the element, it is unchanged.
* More formally, removes the first element {@code e} such that
* {@code Objects.equals(o, e)} (if such an element exists).
* Returns {@code true} if this deque contained the specified element
* (or equivalently, if this deque changed as a result of the call).
*
* @param o element to be removed from this deque, if present
* @return {@code true} if an element was removed as a result of this call
* @throws ClassCastException if the class of the specified element
* is incompatible with this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
*/
@Override
default boolean removeFirstOccurrence(Object o) {
if (o == null) {
return false;
}
if (!(o instanceof Boolean)) {
return false;
}
return this.removeFirstOccurrencePrimitive((Boolean) o);
}
/**
* Primitive replacement of removeFirstOccurrence(Object o)
*
* @param o element to be removed from this deque, if present
* @return {@code true} if an element was removed as a result of this call
* @throws ClassCastException if the class of the specified element
* is incompatible with this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @see #removeFirstOccurrence(Object o)
*/
default boolean removeFirstOccurrence(boolean o) {
return this.removeFirstOccurrencePrimitive(o);
}
/**
* Primitive replacement of removeFirstOccurrence(Object o)
*
* @param o element to be removed from this deque, if present
* @return {@code true} if an element was removed as a result of this call
* @throws ClassCastException if the class of the specified element
* is incompatible with this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @see #removeFirstOccurrence(Object o)
*/
boolean removeFirstOccurrencePrimitive(boolean o);
/**
* Removes the last occurrence of the specified element from this deque.
* If the deque does not contain the element, it is unchanged.
* More formally, removes the last element {@code e} such that
* {@code Objects.equals(o, e)} (if such an element exists).
* Returns {@code true} if this deque contained the specified element
* (or equivalently, if this deque changed as a result of the call).
*
* @param o element to be removed from this deque, if present
* @return {@code true} if an element was removed as a result of this call
* @throws ClassCastException if the class of the specified element
* is incompatible with this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
*/
@Override
default boolean removeLastOccurrence(Object o) {
if (o == null) {
return false;
}
if (!(o instanceof Boolean)) {
return false;
}
return removeLastOccurrencePrimitive((Boolean) o);
}
/**
* Primitive replacement of removeFirstOccurrence(Object o)
*
* @param o element to be removed from this deque, if present
* @return {@code true} if an element was removed as a result of this call
* @throws ClassCastException if the class of the specified element
* is incompatible with this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @see #removeLastOccurrencePrimitive(boolean o)
*/
default boolean removeLastOccurrence(boolean o) {
return removeLastOccurrencePrimitive(o);
}
/**
* Primitive replacement of removeFirstOccurrence(Object o)
*
* @param o element to be removed from this deque, if present
* @return {@code true} if an element was removed as a result of this call
* @throws ClassCastException if the class of the specified element
* is incompatible with this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @see #removeLastOccurrencePrimitive(boolean o)
*/
boolean removeLastOccurrencePrimitive(boolean o);
// *** Queue methods ***
/**
* Inserts the specified element into the queue represented by this deque
* (in other words, at the tail of this deque) if it is possible to do so
* immediately without violating capacity restrictions, returning
* {@code true} upon success and throwing an
* {@code IllegalStateException} if no space is currently available.
* When using a capacity-restricted deque, it is generally preferable to
* use {@link #offer(Boolean) offer}.
*
*
This method is equivalent to {@link #addLast}.
*
* @param e the element to add
* @return {@code true} (as specified by {@link Collection#add})
* @throws IllegalStateException if the element cannot be added at this
* time due to capacity restrictions
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @throws IllegalArgumentException if some property of the specified
* element prevents it from being added to this deque
*/
@Override
default boolean add(Boolean e) {
return BooleanQueue.super.add(e);
}
/**
* Inserts the specified element into the queue represented by this deque
* (in other words, at the tail of this deque) if it is possible to do so
* immediately without violating capacity restrictions, returning
* {@code true} upon success and {@code false} if no space is currently
* available. 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.
*
*
This method is equivalent to {@link #offerLast}.
*
* @param e the element to add
* @return {@code true} if the element was added to this deque, else
* {@code false}
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @throws IllegalArgumentException if some property of the specified
* element prevents it from being added to this deque
*/
@Override
default boolean offer(Boolean e) {
return BooleanQueue.super.offer(e);
}
/**
* Retrieves and removes the head of the queue represented by this deque
* (in other words, the first element of this deque).
* This method differs from {@link #poll() poll()} only in that it
* throws an exception if this deque is empty.
*
*
This method is equivalent to {@link #removeFirst()}.
*
* @return the head of the queue represented by this deque
* @throws NoSuchElementException if this deque is empty
*/
@Override
default Boolean remove() {
return BooleanQueue.super.remove();
}
/**
* Retrieves and removes the head of the queue represented by this deque
* (in other words, the first element of this deque), or returns
* {@code null} if this deque is empty.
*
*
This method is equivalent to {@link #pollFirst()}.
*
* @return the first element of this deque, or {@code null} if
* this deque is empty
*/
@Override
default Boolean poll() {
return BooleanQueue.super.poll();
}
/**
* Retrieves, but does not remove, the head of the queue represented by
* this deque (in other words, the first element of this deque).
* This method differs from {@link #peek peek} only in that it throws an
* exception if this deque is empty.
*
*
This method is equivalent to {@link #getFirst()}.
*
* @return the head of the queue represented by this deque
* @throws NoSuchElementException if this deque is empty
*/
@Override
default Boolean element() {
return BooleanQueue.super.element();
}
/**
* Retrieves, but does not remove, the head of the queue represented by
* this deque (in other words, the first element of this deque), or
* returns {@code null} if this deque is empty.
*
*
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
*/
@Override
default Boolean peek() {
return BooleanQueue.super.peek();
}
/**
* Adds all of the elements in the specified collection at the end
* of this deque, as if by calling {@link #addLast} on each one,
* in the order that they are returned by the collection's iterator.
*
*
When using a capacity-restricted deque, it is generally preferable
* to call {@link #offer(Boolean) offer} separately on each element.
*
*
An exception encountered while trying to add an element may result
* in only some of the elements having been successfully added when
* the associated exception is thrown.
*
* @param c the elements to be inserted into this deque
* @return {@code true} if this deque changed as a result of the call
* @throws IllegalStateException if not all the elements can be added at
* this time due to insertion restrictions
* @throws ClassCastException if the class of an element of the specified
* collection prevents it from being added to this deque
* @throws NullPointerException if the specified collection contains a
* null element and this deque does not permit null elements,
* or if the specified collection is null
* @throws IllegalArgumentException if some property of an element of the
* specified collection prevents it from being added to this deque
*/
@Override
boolean addAll(Collection c);
// *** Stack methods ***
/**
* Pushes an element onto the stack represented by this deque (in other
* words, at the head of this deque) if it is possible to do so
* immediately without violating capacity restrictions, throwing an
* {@code IllegalStateException} if no space is currently available.
*
*
This method is equivalent to {@link #addFirst}.
*
* @param e the element to push
* @throws IllegalStateException if the element cannot be added at this
* time due to capacity restrictions
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @throws IllegalArgumentException if some property of the specified
* element prevents it from being added to this deque
*/
@Override
default void push(Boolean e) {
this.pushPrimitive(e);
}
/**
* Primitive replacement of push(Boolean e)
*
* @param e the element to push
* @throws IllegalStateException if the element cannot be added at this
* time due to capacity restrictions
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @throws IllegalArgumentException if some property of the specified
* element prevents it from being added to this deque
* @see #push(Boolean e)
*/
default void push(boolean e) {
this.pushPrimitive(e);
}
/**
* Primitive replacement of push(Boolean e)
*
* @param e the element to push
* @throws IllegalStateException if the element cannot be added at this
* time due to capacity restrictions
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
* @throws IllegalArgumentException if some property of the specified
* element prevents it from being added to this deque
* @see #push(Boolean e)
*/
void pushPrimitive(boolean e);
/**
* Pops an element from the stack represented by this deque. In other
* words, removes and returns the first element of this deque.
*
*
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 NoSuchElementException if this deque is empty
*/
@Override
default Boolean pop() {
return this.popPrimitive();
}
/**
* Primitive replacement of pop();
*
* @return the element at the front of this deque (which is the top
* of the stack represented by this deque)
* @throws NoSuchElementException if this deque is empty
* @see #pop()
*/
boolean popPrimitive();
// *** Collection methods ***
/**
* Removes the first occurrence of the specified element from this deque.
* If the deque does not contain the element, it is unchanged.
* More formally, removes the first element {@code e} such that
* {@code Objects.equals(o, e)} (if such an element exists).
* Returns {@code true} if this deque contained the specified element
* (or equivalently, if this deque changed as a result of the call).
*
*
This method is equivalent to {@link #removeFirstOccurrence(Object)}.
*
* @param o element to be removed from this deque, if present
* @return {@code true} if an element was removed as a result of this call
* @throws ClassCastException if the class of the specified element
* is incompatible with this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
*/
@Override
default boolean remove(Object o) {
return BooleanQueue.super.remove(o);
}
/**
* Returns {@code true} if this deque contains the specified element.
* More formally, returns {@code true} if and only if this deque contains
* at least one element {@code e} such that {@code Objects.equals(o, e)}.
*
* @param o element whose presence in this deque is to be tested
* @return {@code true} if this deque contains the specified element
* @throws ClassCastException if the class of the specified element
* is incompatible with this deque
* @throws NullPointerException if the specified element is null and this
* deque does not permit null elements
*/
@Override
default boolean contains(Object o) {
return BooleanQueue.super.contains(o);
}
/**
* Returns the number of elements in this deque.
*
* @return the number of elements in this deque
*/
@Override
int size();
/**
* Returns an iterator over the elements in this deque in proper sequence.
* The elements will be returned in order from first (head) to last (tail).
*
* @return an iterator over the elements in this deque in proper sequence
*/
@Override
BooleanIterator iterator();
/**
* Returns an iterator over the elements in this deque in reverse
* sequential order. The elements will be returned in order from
* last (tail) to first (head).
*
* @return an iterator over the elements in this deque in reverse
* sequence
*/
@Override
BooleanIterator descendingIterator();
}