craterdog.collections.interfaces

Interface FIFO<E>

Type Parameters:

E - The type of element managed by the collection.

All Known Implementing Classes:

Queue

public interface FIFO<E>

This interface defines the methods that must be implemented by each collection that supports a "first in, first out" access pattern. This pattern is usually used by multiple threads to implement a shared queue.

Author:

Derk Norton

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.

Method Detail

addElementToTail

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

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.

Parameters:

element - The new element to be added.

Throws:

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

removeElementFromHead

E removeElementFromHead()
                 throws java.lang.InterruptedException

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.

Returns:

The head element in the queue.

Throws:

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

getHeadElement

E getHeadElement()

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

Returns:

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