org.mule.runtime.core.api.util.queue

Interface Queue

All Superinterfaces:

org.mule.runtime.api.meta.NamedObject

All Known Implementing Classes:

TransactionAwareQueueStore

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

Interface for mule queues used for VM.

Method Summary

Modifier and Type	Method and 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)
Serializable	peek()
Serializable	poll(long timeout)
void	put(Serializable object) Puts a new object in this queue and wait if necessary.
int	size() Returns the number of elements in this queue.
Serializable	take() Blocks and retrieves an object from this queue.
void	untake(Serializable item)

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

getName

Method Detail

size

int size()

Returns the number of elements in this queue.

put

void put(Serializable object)
  throws InterruptedException,
         org.mule.runtime.api.store.ObjectStoreException

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

Throws:

InterruptedException

org.mule.runtime.api.store.ObjectStoreException

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,
            org.mule.runtime.api.store.ObjectStoreException

Throws:

InterruptedException

org.mule.runtime.api.store.ObjectStoreException

peek

Serializable peek()
           throws InterruptedException

Throws:

InterruptedException

poll

Serializable poll(long timeout)
           throws InterruptedException

Throws:

InterruptedException

offer

boolean offer(Serializable object,
              long timeout)
       throws InterruptedException,
              org.mule.runtime.api.store.ObjectStoreException

Throws:

InterruptedException

org.mule.runtime.api.store.ObjectStoreException

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