com.phloc.commons.concurrent.collector

Interface IConcurrentCollector<DATATYPE>

Type Parameters:

DATATYPE - The type of objects to be queued

All Known Implementing Classes:

AbstractConcurrentCollector, ConcurrentCollectorMultiple, ConcurrentCollectorSingle

public interface IConcurrentCollector<DATATYPE>

Base interface for a concurrent queue worker. It asynchronously collects objects to handle (via the queueObject(Object) method).

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
int	getQueueLength()
boolean	isStopped() Check if this collector is already stopped.
ESuccess	queueObject(DATATYPE aObject) Submit an object to the queue.
ESuccess	stopQueuingNewObjects() Stop taking new objects in the collector.

Method Detail

queueObject

@Nonnull
ESuccess queueObject(@Nonnull
                           DATATYPE aObject)

Submit an object to the queue.

Parameters:

aObject - The object to submit. May not be null.

Returns:

ESuccess

getQueueLength

@Nonnegative
int getQueueLength()

Returns:

The number of objects currently in the queue.

stopQueuingNewObjects

@Nonnull
ESuccess stopQueuingNewObjects()

Stop taking new objects in the collector. Returns directly and does not wait until the processing finished.

Returns:

ESuccess

isStopped

boolean isStopped()

Check if this collector is already stopped.

Returns:

true if the collector is stopped, false otherwise.