redblacktreetesterproject

Class Queue

java.lang.Object

redblacktreetesterproject.Queue

public class Queue
extends java.lang.Object

The Queue is a first in first out data structure. This Queue holds Java Object references. It grows dynamically as long as memory is available. Note: Many of these Javadoc comments describe implementation details. For non-classroom use, these implementation details would not be exposed.

Constructor Summary

Constructors

Constructor and Description
Queue() Create an empty queue that lives in a small array.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	deQueue() Object method removes and returns reference in front of queue.
void	enQueue(java.lang.Object x) Add an object reference to the rear of the queue.
java.lang.Object	getFront() Method getFront returns the front of the queue without removing it.
boolean	isEmpty() Boolean method returns true on empty queue, false otherwise.
boolean	isFull() Boolean method returns true if queue is currently at capacity, false otherwise.
static void	main(java.lang.String[] a) main is for testing the queue routines.
java.lang.String	toString() The toString method returns a String representation of the current queue contents.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Queue

public Queue()

Create an empty queue that lives in a small array. Pre: Memory is available. Post: Array created and indexes established.

Method Detail

isEmpty

public boolean isEmpty()

Boolean method returns true on empty queue, false otherwise. Pre: None

Returns:

Returns true if queue is empty.

isFull

public boolean isFull()

Boolean method returns true if queue is currently at capacity, false otherwise. If full returns true and additional enqueue calls are made, the queue will expand in size. Pre: None

Returns:

Returns true if queue is at current capacity.

deQueue

public java.lang.Object deQueue()

Object method removes and returns reference in front of queue. Pre-condition: queue not empty

Returns:

object in front of queue.

enQueue

public void enQueue(java.lang.Object x)

Add an object reference to the rear of the queue. Pre-condition Memory is available for doubling queue capacity when full. Post-condition: queue now contains x in the rear.

Parameters:

x - is an object to be added to the rear of the queue.

getFront

public java.lang.Object getFront()

Method getFront returns the front of the queue without removing it. Pre-condition: queue not empty

Returns:

the queue front without removal.

toString

public java.lang.String toString()

The toString method returns a String representation of the current queue contents.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the queue. It shows the front of the queue first. It then shows the second and third and so on.

main

public static void main(java.lang.String[] a)

main is for testing the queue routines.

Parameters:

a - Command line parameters are not used.