org.calrissian.mango.batch

Interface Batcher<T>

All Superinterfaces:

AutoCloseable, Closeable

public interface Batcher<T>
extends Closeable

Batches items into collections. Items can be added to a batcher to be included in a batch. To construct a new Batcher, use BatcherBuilder to generate a configured Batcher.

Batchers utilize a queue to buffer items while batches are being constructed. When a buffer size if provided, callers can be prevented from overwhelming the queue with data. Use the appropriate add method to manage a full queue.

Method Summary

Modifier and Type	Method and Description
boolean	add(T item) Adds a new item to be batched.
boolean	add(T item, long timeout, TimeUnit unit) Adds a new item to be batched.
boolean	addOrWait(T item) Adds a new item to be batched.
void	close() Closes the underlying batcher.
List<T>	closeAndFlush() Closes the underlying batcher and flushes the remaining elements in the queue to a list.

Method Detail

add

boolean add(T item)

Adds a new item to be batched. If this batcher was constructed with a max buffer size, this method will attempt to add a new item if there is room, otherwise will return false immediately.

add

boolean add(T item,
            long timeout,
            TimeUnit unit)
     throws InterruptedException

Adds a new item to be batched. If this batcher was constructed with a max queue size, this method will wait until there is room in the buffer to add the data or it has timed out.

Throws:

InterruptedException

addOrWait

boolean addOrWait(T item)
           throws InterruptedException

Adds a new item to be batched. If this batcher was constructed with a max queue size, this method will wait until there is room in the buffer to add the data. Note: If this batcher is closed and there are producers blocking on this call, they may be stuck until they are interrupted. If using a max buffer size, it is suggested that one of the other add methods be used.

Throws:

InterruptedException

closeAndFlush

List<T> closeAndFlush()

Closes the underlying batcher and flushes the remaining elements in the queue to a list. This blocks until all submitted batches have been processed.

close

void close()

Closes the underlying batcher. This blocks until all submitted batches have been processed.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable