craterdog.collections

Class Queue<E>

java.lang.Object

craterdog.collections.abstractions.Collection<E>

craterdog.collections.abstractions.ClosedCollection<E>

craterdog.collections.Queue<E>

Type Parameters:

E - The type of element managed by this collection.

All Implemented Interfaces:

Accessible<E>, FIFO<E>, Composite, Sequential<E>, java.lang.Comparable<Collection<E>>, java.lang.Iterable<E>

public class Queue<E>
extends ClosedCollection<E>
implements FIFO<E>

This collection class implements a queue (FIFO) data structure. Normally, multiple threads will be accessing a queue at the same time. This class enforces synchronized access to all methods of this class. The implementation dynamically scales up and down the size of the underlying data structures as the number elements changes over time.

Author:

Derk Norton

Field Summary

Fields inherited from class craterdog.collections.abstractions.ClosedCollection

list

Constructor Summary

Constructors

Constructor and Description
Queue() This constructor creates a new queue of unlimited capacity.
Queue(int capacity) This constructor creates a new queue with the specified capacity.

Method Summary

Modifier and Type	Method and Description
void	addElementToTail(E element) This method adds a new element to the tail of the queue.
E	getHeadElement() This method returns a reference to the element at the head of the queue without removing the element from the queue.
E	removeElementFromHead() This method removes the next element from the head of the queue.

Methods inherited from class craterdog.collections.abstractions.ClosedCollection

createDefaultIterator, getElementAtIndex, getElementsInRange, getIndexOfElement, getNumberOfElements, removeAllElements

Methods inherited from class craterdog.collections.abstractions.Collection

compareTo, containsAllElementsIn, containsAnyElementsIn, containsElement, equals, hashCode, isEmpty, iterator, normalizedIndex, toArray, toArray, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Queue

public Queue()

This constructor creates a new queue of unlimited capacity.

Queue

public Queue(int capacity)

This constructor creates a new queue with the specified capacity.

Parameters:

capacity - The maximum number of elements that can be in the queue at one time.

Method Detail

addElementToTail

public final void addElementToTail(E element)
                            throws java.lang.InterruptedException

Description copied from interface: FIFO

This method adds a new element to the tail of the queue. If the queue is currently at capacity this method will block until the capacity drops.

Specified by:

addElementToTail in interface FIFO<E>

Parameters:

element - The new element to be added.

Throws:

java.lang.InterruptedException - The thread that was waiting to add an element was interrupted.

removeElementFromHead

public final E removeElementFromHead()
                              throws java.lang.InterruptedException

Description copied from interface: FIFO

This method removes the next element from the head of the queue. If the queue is empty, the method blocks until an element is available.

Specified by:

removeElementFromHead in interface FIFO<E>

Returns:

The head element in the queue.

Throws:

java.lang.InterruptedException - The thread that was waiting to remove an element was interrupted.

getHeadElement

public final E getHeadElement()

Description copied from interface: FIFO

This method returns a reference to the element at the head of the queue without removing the element from the queue.

Specified by:

getHeadElement in interface FIFO<E>

Returns:

The head element in the queue, or null if the queue is empty.