org.calrissian.mango.batch

Interface Batcher<T>

All Superinterfaces:

AutoCloseable, Closeable

public interface Batcher<T>
extends Closeable

Method Summary

Methods

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()

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

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable