Interface DoubleEndedQueueInterface<E>

Type Parameters:

E - The generic parameter that specifies the type of elements in the DoubleEndedQueue.

All Superinterfaces:

java.lang.Iterable<E>

public interface DoubleEndedQueueInterface<E>
extends java.lang.Iterable<E>

This is the DoubleEndedQueueInterface for the Midterm Exam of CMP-338.

The DoubleEndedQueue ADT is a double-ended queue. Users are allowed to add and remove elements from both the front and the back of the DoubleEndedQueue.

Author:

Sameh Fakhouri

Method Summary

Modifier and Type	Method and Description
void	addBack(E element) Adds the specified element to the back of the DoubleEndedQueue.
void	addFront(E element) Adds the specified element to the front of the DoubleEndedQueue.
boolean	isEmpty() This method is called to determine if the DoubleEndedQueue is empty.
E	peekBack() Retrieves, but does not remove element at the back of the DoubleEndedQueue.
E	peekFront() Retrieves, but does not remove element at the front of the DoubleEndedQueue.
void	removeAll() Removes all elements from the DoubleEndedQueue making it empty.
E	removeBack() Retrieves and removes the element at the back of the DoubleEndedQueue.
E	removeFront() Retrieves and removes the element at the front of the DoubleEndedQueue.
int	size() This method is called to obtain the count of elements in the list.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

isEmpty

boolean isEmpty()

This method is called to determine if the DoubleEndedQueue is empty.

Returns:

Returns true if the DoubleEndedQueue is empty, otherwise it returns false.

size

int size()

This method is called to obtain the count of elements in the list.

Returns:

Returns the numbers of elements that are currently in the DoubleEndedQueue.

addFront

void addFront(E element)
       throws java.lang.NullPointerException

Adds the specified element to the front of the DoubleEndedQueue. If the specified element is null the method will throw a NullPointerException.

Parameters:

element - The element to add.

Throws:

java.lang.NullPointerException - If the specified element being added is null.

addBack

void addBack(E element)
      throws java.lang.NullPointerException

Adds the specified element to the back of the DoubleEndedQueue. If the specified element is null the method will throw a NullPointerException.

Parameters:

element - The element to add.

Throws:

java.lang.NullPointerException - If the specified element being added is null.

removeFront

E removeFront()

Retrieves and removes the element at the front of the DoubleEndedQueue.

Returns:

The element at the front of the DoubleEndedQueue or null if the DoubleEndedQueue is empty.

removeBack

E removeBack()

Retrieves and removes the element at the back of the DoubleEndedQueue.

Returns:

The element at the back of the DoubleEndedQueue or null if the DoubleEndedQueue is empty.

peekFront

E peekFront()

Retrieves, but does not remove element at the front of the DoubleEndedQueue.

Returns:

The element at the front of the DoubleEndedQueue or null if the DoubleEndedQueue is empty.

peekBack

E peekBack()

Retrieves, but does not remove element at the back of the DoubleEndedQueue.

Returns:

The element at the back of the DoubleEndedQueue or null if the DoubleEndedQueue is empty.

removeAll

void removeAll()

Removes all elements from the DoubleEndedQueue making it empty.