com.quadcap.util.collections.ArrayQueue Class Reference

Inheritance diagram for com.quadcap.util.collections.ArrayQueue:

Detailed Description

Implements the Queue interface using a growable array.

Author:: Stan Bailes

Definition at line 46 of file ArrayQueue.java.

Public Member Functions

ArrayQueue ()

Create an empty Array queue with unbounded capacity.

ArrayQueue (int capacity)

Create an empty queue with an initial capacity.

ArrayQueue (int initialSize, int capacity)

Create an ArrayQueue with an initial capacity.

final void setCapacity (int capacity)

Specify the maximum capacity of this queue, -1 means unbounded.

final int size ()

Return the number of items in the queue.

final void pushFront (Object obj)

Add an object to the front of the queue.

final void addFront (Object obj)

Add an object to the front of the queue.

final void pushBack (Object obj)

Add an object to the back of the queue.

final void addBack (Object obj)

Add an object to the back of the queue.

final Object head ()

Access the object at the front of the queue.

final Object tail ()

Access the object at the back of the queue.

final Object popFront ()

Remove and return the item at the front of the queue.

final Object popBack ()

Remove and return the item at the back of the queue.

final void push (Object obj)

final Object pop ()

final Object top ()

final Object top (int pos)

final void remove (Object obj)

Remove the specified object.

String toString ()

Package Functions

final void checkSizeForAdd ()

final void resize (int newsize)

Package Attributes

int head = 0

int tail = 0

int capacity = 0

Object[] queue = null

Constructor & Destructor Documentation

com.quadcap.util.collections.ArrayQueue.ArrayQueue ( )

Create an empty Array queue with unbounded capacity.

Definition at line 55 of file ArrayQueue.java.

com.quadcap.util.collections.ArrayQueue.ArrayQueue ( int capacity )

Create an empty queue with an initial capacity.

Definition at line 62 of file ArrayQueue.java.

com.quadcap.util.collections.ArrayQueue.ArrayQueue ( int initialSize,

int capacity

)

Create an ArrayQueue with an initial capacity.

Definition at line 69 of file ArrayQueue.java.

Member Function Documentation

final void com.quadcap.util.collections.ArrayQueue.checkSizeForAdd ( ) [package]

Definition at line 234 of file ArrayQueue.java.
References com.quadcap.util.collections.ArrayQueue.capacity, com.quadcap.util.collections.ArrayQueue.queue, com.quadcap.util.collections.ArrayQueue.resize(), and com.quadcap.util.collections.ArrayQueue.size().
Referenced by com.quadcap.util.collections.ArrayQueue.addBack(), and com.quadcap.util.collections.ArrayQueue.addFront().

final Object com.quadcap.util.collections.ArrayQueue.head ( )

Access the object at the front of the queue.
Return null if the queue is empty.

Returns:
the item at the head of the queue

Implements com.quadcap.util.collections.Queue.
Definition at line 139 of file ArrayQueue.java.
References com.quadcap.util.collections.ArrayQueue.queue, and com.quadcap.util.collections.ArrayQueue.size().

final Object com.quadcap.util.collections.ArrayQueue.pop ( )

Definition at line 195 of file ArrayQueue.java.
References com.quadcap.util.collections.ArrayQueue.popBack().

final Object com.quadcap.util.collections.ArrayQueue.popBack ( )

Remove and return the item at the back of the queue.
Return null if the queue is empty.

Returns:
the item at the tail of the queue

Implements com.quadcap.util.collections.Queue.
Definition at line 182 of file ArrayQueue.java.
References com.quadcap.util.collections.ArrayQueue.queue, and com.quadcap.util.collections.ArrayQueue.size().
Referenced by com.quadcap.util.collections.ArrayQueue.pop().

final Object com.quadcap.util.collections.ArrayQueue.popFront ( )

Remove and return the item at the front of the queue.
Return null if the queue is empty.

Returns:
the item at the head of the queue

Implements com.quadcap.util.collections.Queue.
Definition at line 167 of file ArrayQueue.java.
References com.quadcap.util.collections.ArrayQueue.queue, and com.quadcap.util.collections.ArrayQueue.size().

final void com.quadcap.util.collections.ArrayQueue.push ( Object obj )

Definition at line 191 of file ArrayQueue.java.
References com.quadcap.util.collections.ArrayQueue.push().
Referenced by com.quadcap.util.collections.ArrayQueue.push().

final void com.quadcap.util.collections.ArrayQueue.pushBack ( Object obj )

Add an object to the back of the queue.

Parameters:

obj the object to add

Definition at line 123 of file ArrayQueue.java.
References com.quadcap.util.collections.ArrayQueue.addBack(), and com.quadcap.util.collections.ArrayQueue.pushBack().
Referenced by com.quadcap.util.collections.ArrayQueue.pushBack().

final void com.quadcap.util.collections.ArrayQueue.pushFront ( Object obj )

Add an object to the front of the queue.

Parameters:

obj the object to add

Definition at line 109 of file ArrayQueue.java.
References com.quadcap.util.collections.ArrayQueue.addFront(), and com.quadcap.util.collections.ArrayQueue.pushFront().
Referenced by com.quadcap.util.collections.ArrayQueue.pushFront().

final void com.quadcap.util.collections.ArrayQueue.remove ( Object obj )

Remove the specified object.

Definition at line 216 of file ArrayQueue.java.
References com.quadcap.util.collections.ArrayQueue.queue, com.quadcap.util.collections.ArrayQueue.remove(), and com.quadcap.util.collections.ArrayQueue.size().
Referenced by com.quadcap.util.collections.ArrayQueue.remove().

final void com.quadcap.util.collections.ArrayQueue.resize ( int newsize ) [package]

Definition at line 249 of file ArrayQueue.java.
References com.quadcap.util.collections.ArrayQueue.queue, and com.quadcap.util.collections.ArrayQueue.resize().
Referenced by com.quadcap.util.collections.ArrayQueue.checkSizeForAdd(), com.quadcap.util.collections.ArrayQueue.resize(), and com.quadcap.util.collections.ArrayQueue.setCapacity().

final void com.quadcap.util.collections.ArrayQueue.setCapacity ( int capacity )

Specify the maximum capacity of this queue, -1 means unbounded.

Parameters:

capacity the new capacity of the queue, or -1 to specify a queue of unlimited size.

Implements com.quadcap.util.collections.Queue.
Definition at line 80 of file ArrayQueue.java.
References com.quadcap.util.collections.ArrayQueue.queue, com.quadcap.util.collections.ArrayQueue.resize(), com.quadcap.util.collections.ArrayQueue.setCapacity(), and com.quadcap.util.collections.ArrayQueue.size().
Referenced by com.quadcap.util.collections.ArrayQueue.setCapacity().

final Object com.quadcap.util.collections.ArrayQueue.tail ( )

Access the object at the back of the queue.
Return null if the queue is empty.

Returns:
the item at the tail of the queue

Implements com.quadcap.util.collections.Queue.
Definition at line 153 of file ArrayQueue.java.
References com.quadcap.util.collections.ArrayQueue.queue, and com.quadcap.util.collections.ArrayQueue.size().
Referenced by com.quadcap.util.collections.ArrayQueue.top().

final Object com.quadcap.util.collections.ArrayQueue.top ( int pos )

Definition at line 203 of file ArrayQueue.java.
References com.quadcap.util.collections.ArrayQueue.queue, and com.quadcap.util.collections.ArrayQueue.size().

final Object com.quadcap.util.collections.ArrayQueue.top ( )

Definition at line 199 of file ArrayQueue.java.
References com.quadcap.util.collections.ArrayQueue.tail().

String com.quadcap.util.collections.ArrayQueue.toString ( )

Definition at line 269 of file ArrayQueue.java.
References com.quadcap.util.collections.ArrayQueue.queue, and com.quadcap.util.collections.ArrayQueue.size().

Member Data Documentation

int com.quadcap.util.collections.ArrayQueue.capacity = 0 [package]

Definition at line 49 of file ArrayQueue.java.
Referenced by com.quadcap.util.collections.ArrayQueue.checkSizeForAdd().

int com.quadcap.util.collections.ArrayQueue.head = 0 [package]

Definition at line 47 of file ArrayQueue.java.
Referenced by com.quadcap.util.collections.ArrayQueue.addFront(), and com.quadcap.util.collections.ArrayQueue.size().

int com.quadcap.util.collections.ArrayQueue.tail = 0 [package]

Definition at line 48 of file ArrayQueue.java.
Referenced by com.quadcap.util.collections.ArrayQueue.addBack(), and com.quadcap.util.collections.ArrayQueue.size().


Public Member Functions
	ArrayQueue ()
	Create an empty Array queue with unbounded capacity.
	ArrayQueue (int capacity)
	Create an empty queue with an initial capacity.
	ArrayQueue (int initialSize, int capacity)
	Create an ArrayQueue with an initial capacity.
final void	setCapacity (int capacity)
	Specify the maximum capacity of this queue, -1 means unbounded.
final int	size ()
	Return the number of items in the queue.
final void	pushFront (Object obj)
	Add an object to the front of the queue.
final void	addFront (Object obj)
	Add an object to the front of the queue.
final void	pushBack (Object obj)
	Add an object to the back of the queue.
final void	addBack (Object obj)
	Add an object to the back of the queue.
final Object	head ()
	Access the object at the front of the queue.
final Object	tail ()
	Access the object at the back of the queue.
final Object	popFront ()
	Remove and return the item at the front of the queue.
final Object	popBack ()
	Remove and return the item at the back of the queue.
final void	push (Object obj)
final Object	pop ()
final Object	top ()
final Object	top (int pos)
final void	remove (Object obj)
	Remove the specified object.
String	toString ()
Package Functions
final void	checkSizeForAdd ()
final void	resize (int newsize)
Package Attributes
int	head = 0
int	tail = 0
int	capacity = 0
Object[]	queue = null