org.mule.runtime.core.internal.streaming.object.iterator

Class QueueProducer<T>

java.lang.Object

org.mule.runtime.core.internal.streaming.object.iterator.QueueProducer<T>

All Implemented Interfaces:

Closeable, AutoCloseable, org.mule.runtime.api.streaming.HasSize, Producer<T>

public class QueueProducer<T>
extends Object
implements Producer<T>

Implementation of Producer to stream the contents of a Queue A polling timeout value might be specified, otherwise the default value of 5000 milliseconds will be assumed

Constructor Summary

Constructors

Constructor and Description
QueueProducer(Queue queue) Creates an instance with 5000 milliseconds as the default polling value
QueueProducer(Queue queue, long timeout)

Method Summary

Modifier and Type	Method and Description
void	close()
int	getSize()
T	produce() Returns the next available item

Methods inherited from class java.lang.Object

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

Constructor Detail

QueueProducer

public QueueProducer(Queue queue)

Creates an instance with 5000 milliseconds as the default polling value

Parameters:

queue - the queue to stream from

QueueProducer

public QueueProducer(Queue queue,
                     long timeout)

Method Detail

produce

public T produce()

Returns the next available item This implementation will poll from the queue once and will return the obtained item. If the producer is closed or if the queue times out while polling, then null is returned. If the poll method throws InterruptedException then null is returned as well

Specified by:

produce in interface Producer<T>

Returns:

an item. Might be null

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getSize

public int getSize()

Specified by:

getSize in interface org.mule.runtime.api.streaming.HasSize