jadex.commons.collection

Class ArrayBlockingQueue<T>

java.lang.Object

jadex.commons.collection.ArrayBlockingQueue<T>

All Implemented Interfaces:

IBlockingQueue<T>

public class ArrayBlockingQueue<T>
extends Object
implements IBlockingQueue<T>

Blocking queue implemented as array. The array is expanded automatically when the queue grows.

Nested Class Summary

Nested classes/interfaces inherited from interface jadex.commons.collection.IBlockingQueue

IBlockingQueue.ClosedException

Constructor Summary

Constructors

Constructor and Description
ArrayBlockingQueue() Create a new blocking queue.

Method Summary

Methods

Modifier and Type	Method and Description
T	dequeue() Remove an object from the queue (blocks until an element is available).
T	dequeue(long timeout) Dequeue an element.
void	enqueue(Object o) Add an element to the end of the queue.
boolean	isClosed() Check if the queue is closed.
T	peek() Peek the topmost element without dequeuing it.
List<T>	setClosed(boolean closed) Open/close the queue.
int	size() Get the number of elements in the queue.
String	toString() Create a string representation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ArrayBlockingQueue

public ArrayBlockingQueue()

Create a new blocking queue.

Method Detail

size

public int size()

Get the number of elements in the queue.

Specified by:

size in interface IBlockingQueue<T>

Returns:

The size.

enqueue

public void enqueue(Object o)

Add an element to the end of the queue.

Specified by:

enqueue in interface IBlockingQueue<T>

Parameters:

o - The element.

dequeue

public T dequeue(long timeout)
          throws IBlockingQueue.ClosedException,
                 TimeoutException

Dequeue an element.

Specified by:

dequeue in interface IBlockingQueue<T>

Parameters:

timeout - the time to wait (in millis) or -1 for no timeout.

Returns:

The element. When queue is empty the methods blocks until an element is added or the timeout occurs.

Throws:

IBlockingQueue.ClosedException

TimeoutException

peek

public T peek()
       throws IBlockingQueue.ClosedException

Peek the topmost element without dequeuing it.

Specified by:

peek in interface IBlockingQueue<T>

Returns:

The element. When queue is empty the methods blocks until an element is added.

Throws:

IBlockingQueue.ClosedException

dequeue

public T dequeue()

Remove an object from the queue (blocks until an element is available).

Specified by:

dequeue in interface IBlockingQueue<T>

Returns:

The element. When queue is empty the methods blocks until an element is added.

setClosed

public List<T> setClosed(boolean closed)

Open/close the queue.

Specified by:

setClosed in interface IBlockingQueue<T>

Parameters:

closed - The closed state.

Returns:

The remaining elements after the queue has been closed.

isClosed

public boolean isClosed()

Check if the queue is closed.

Specified by:

isClosed in interface IBlockingQueue<T>

toString

public String toString()

Create a string representation.

Overrides:

toString in class Object