Queue (Crater Dog Java Collection Framework 3.3 API)

java.lang.Object
- craterdog.collections.Queue<E>

Type Parameters:

E - The type of element managed by this collection.

All Implemented Interfaces:

FIFO<E>, Iteratable<E>, Composite, Sequential<E>, java.lang.Iterable<E>
```
public class Queue<E>
extends java.lang.Object
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

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTailElement(E element)` This method adds a new element to the tail of the queue.
`Iterator<E>`	`createDefaultIterator()` This method creates a new default iterator for the collection.
`E`	`getHeadElement()` This method returns a reference to the element at the head of the queue without removing the element from the queue.
`int`	`getNumberOfElements()`
`boolean`	`isEmpty()`
`Iterator<E>`	`iterator()`
`void`	`removeAllElements()` This method removes all elements from the collection.
`E`	`removeHeadElement()` This method removes the next element from the head of the queue.
`void`	`toArray(E[] array)`
`java.lang.String`	`toString()`
`java.lang.String`	`toString(java.lang.String indentation)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, 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
  - isEmpty
```
public final boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Sequential<E>
  - getNumberOfElements
```
public final int getNumberOfElements()
```
    Specified by:
    
    getNumberOfElements in interface Sequential<E>
  - createDefaultIterator
```
public final Iterator<E> createDefaultIterator()
```
    Description copied from interface: Iteratable
    
    This method creates a new default iterator for the collection.
    
    Specified by:
    
    createDefaultIterator in interface Iteratable<E>
    
    Returns:
    
    A new default iterator for the collection.
  - toArray
```
public final void toArray(E[] array)
```
    Specified by:
    
    toArray in interface Sequential<E>
  - addTailElement
```
public final void addTailElement(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:
    
    addTailElement 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.
  - removeHeadElement
```
public final E removeHeadElement()
                          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:
    
    removeHeadElement 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.
  - removeAllElements
```
public final void removeAllElements()
```
    Description copied from interface: Iteratable
    
    This method removes all elements from the collection.
    
    Specified by:
    
    removeAllElements in interface Iteratable<E>
  - 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.
  - iterator
```
public final Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface Sequential<E>
    
    Specified by:
    
    iterator in interface java.lang.Iterable<E>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toString
```
public java.lang.String toString(java.lang.String indentation)
```
    Specified by:
    
    toString in interface Composite

Class Queue<E>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Queue

Queue

Method Detail

isEmpty

getNumberOfElements

createDefaultIterator

toArray

addTailElement

removeHeadElement

removeAllElements

getHeadElement

iterator

toString

toString