Module org.mule.sdk.api

Package org.mule.sdk.api.queue

Interface Queue

All Superinterfaces:

org.mule.runtime.api.meta.NamedObject

@NoImplement
public interface Queue
extends org.mule.runtime.api.meta.NamedObject

Interface for mule queues used for VM.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
void	clear()	Discards all the elements in the queue
void	dispose()	Disposes this queue by releasing it's storage and associated memory and storage.
boolean	offer(Serializable object, long timeout)	Puts an item to the queue, considering timeout on this operation.
Serializable	peek()
Serializable	poll(long timeout)	Takes an element from the queue, with a timeout on this operation.
void	put(Serializable object)	Puts a new object in this queue and wait if necessary.
int	size()
Serializable	take()	Blocks and retrieves an object from this queue.
void	untake(Serializable item)	Puts back an element in the queue, for example, after a rollback operation.

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

Method Details

size

int size()

Returns:

the number of elements in this queue.

put

void put(Serializable object)
  throws InterruptedException

Puts a new object in this queue and wait if necessary.

Throws:

InterruptedException

take

Serializable take()
           throws InterruptedException

Blocks and retrieves an object from this queue.

Returns:

an object.

Throws:

InterruptedException

untake

void untake(Serializable item)
     throws InterruptedException

Puts back an element in the queue, for example, after a rollback operation.

Parameters:

item - the item to untake.

Throws:

InterruptedException

peek

Serializable peek()
           throws InterruptedException

Returns:

the next element in the Queue.

Throws:

InterruptedException

poll

Serializable poll(long timeout)
           throws InterruptedException

Takes an element from the queue, with a timeout on this operation.

Parameters:

timeout - (in millis) the timeout to consider for the operation.

Returns:

an Object.

Throws:

InterruptedException

offer

boolean offer(Serializable object,
 long timeout)
       throws InterruptedException

Puts an item to the queue, considering timeout on this operation.

Parameters:

object - to be offered.

timeout - (in millis) to consider to offer the element to the queue.

Returns:

true if the element could be added to the queue.

Throws:

InterruptedException

clear

void clear()
    throws InterruptedException

Discards all the elements in the queue

Throws:

InterruptedException

dispose

void dispose()
      throws org.mule.runtime.api.exception.MuleException,
InterruptedException

Disposes this queue by releasing it's storage and associated memory and storage. If after disposing the queue you try go get it back, you'll get a fresh new one which maintains none of the original one's data

Throws:

org.mule.runtime.api.exception.MuleException

InterruptedException