org.ws4d.java.structures

Class Queue

java.lang.Object

org.ws4d.java.structures.Queue

Direct Known Subclasses:

WaitingQueue

public class Queue
extends java.lang.Object

Simple Queue. Thread safe!?! ;-)

Constructor Summary

Constructors

Constructor and Description
Queue() Create a new fine queue.

Method Summary

Modifier and Type	Method and Description
protected void	addElement(java.lang.Object o, int index) Adds element to vector at specified position.
java.lang.Object	checkFirst() Returns the first element of this queue WITHOUT removing it!
protected java.lang.Object	checkFirstElement() Returns the first element of this queue.
void	clear() Removes all entries from this queue.
void	enqueue(java.lang.Object o) Enqueues element into this queue.
void	enqueueAtBeginning(java.lang.Object o) Adds elements to this queue, but the element will be set on the beginning of the queue.
java.lang.Object	get() Returns the first element of this queue.
protected java.lang.Object	getFirstElement() Returns the first element of this queue.
boolean	isEmpty() Tests that this queue has no components.
Iterator	iterator() Returns an iterator for this queue.
int	size() Returns the number of components in this queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

Queue

public Queue()

Create a new fine queue.

Method Detail

isEmpty

public boolean isEmpty()

Tests that this queue has no components.

Returns:

true if and only if this queue has no components, that is, its size is zero; false otherwise.

enqueue

public void enqueue(java.lang.Object o)

Enqueues element into this queue.

Parameters:

o - element to enqueue.

enqueueAtBeginning

public void enqueueAtBeginning(java.lang.Object o)

Adds elements to this queue, but the element will be set on the beginning of the queue.

Parameters:

o - element to enqueue.

get

public java.lang.Object get()

Returns the first element of this queue. The first element is removed from queue, element at index 1 becomes first, etc.

Returns:

The first element.

checkFirst

public java.lang.Object checkFirst()

Returns the first element of this queue WITHOUT removing it!

Returns:

The first element.

clear

public void clear()

Removes all entries from this queue.

iterator

public Iterator iterator()

Returns an iterator for this queue.

This iterator allows to access every item inside this queue and supports the remove method.

Returns:

the iterator for this queue.

size

public int size()

Returns the number of components in this queue.

Returns:

the number of components in this queue.

getFirstElement

protected java.lang.Object getFirstElement()

Returns the first element of this queue. The first element is removed from queue, element at index 1 becomes first, etc.

Returns:

the first element.

checkFirstElement

protected java.lang.Object checkFirstElement()

Returns the first element of this queue.

Returns:

the first element.

addElement

protected void addElement(java.lang.Object o,
                          int index)

Adds element to vector at specified position. If the position is -1 the object will added to the end of the vector.

Parameters:

o - object to add.

index - where to insert the object. If -1, the object will be added at the end.