com.helger.commons.concurrent.collector

Class AbstractConcurrentCollector<DATATYPE>

java.lang.Object

com.helger.commons.concurrent.collector.AbstractConcurrentCollector<DATATYPE>

Type Parameters:

DATATYPE - The type of the objects in the queue.

All Implemented Interfaces:

INonThrowingRunnable, IThrowingRunnable<Exception>, IConcurrentCollector<DATATYPE>, IMutableConcurrentCollector<DATATYPE>, Runnable

Direct Known Subclasses:

ConcurrentCollectorMultiple, ConcurrentCollectorSingle

@ThreadSafe
public abstract class AbstractConcurrentCollector<DATATYPE>
extends Object
implements INonThrowingRunnable, IMutableConcurrentCollector<DATATYPE>

Abstract concurrent collector based on BlockingQueue.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_QUEUE_SIZE Default maximum queue size
protected BlockingQueue<Object>	m_aQueue
static Object	STOP_QUEUE_OBJECT The STOP object that is internally added to the queue to indicate the last token

Constructor Summary

Constructors

Constructor and Description
AbstractConcurrentCollector(BlockingQueue<Object> aQueue) Constructor using an arbitrary BlockingQueue.
AbstractConcurrentCollector(int nMaxQueueSize) Constructor creating an ArrayBlockingQueue internally.

Method Summary

Modifier and Type	Method and Description
List<DATATYPE>	drainQueue()
int	getQueueLength()
boolean	isQueueEmpty()
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.callback.INonThrowingRunnable

run

Field Detail

DEFAULT_MAX_QUEUE_SIZE

public static final int DEFAULT_MAX_QUEUE_SIZE

Default maximum queue size

See Also:

Constant Field Values

STOP_QUEUE_OBJECT

public static final Object STOP_QUEUE_OBJECT

The STOP object that is internally added to the queue to indicate the last token

m_aQueue

protected final BlockingQueue<Object> m_aQueue

Constructor Detail

AbstractConcurrentCollector

public AbstractConcurrentCollector(@Nonnegative
                                   int nMaxQueueSize)

Constructor creating an ArrayBlockingQueue internally.

Parameters:

nMaxQueueSize - The maximum number of items that can be in the queue. Must be > 0.

AbstractConcurrentCollector

public AbstractConcurrentCollector(@Nonnull
                                   BlockingQueue<Object> aQueue)

Constructor using an arbitrary BlockingQueue.

Parameters:

aQueue - The BlockingQueue to be used. May not be null.

Method Detail

queueObject

@Nonnull
public final ESuccess queueObject(@Nonnull
                                            DATATYPE aObject)

Description copied from interface: IMutableConcurrentCollector

Submit an object to the queue.

Specified by:

queueObject in interface IMutableConcurrentCollector<DATATYPE>

Parameters:

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

Returns:

ESuccess

isQueueEmpty

public boolean isQueueEmpty()

Specified by:

isQueueEmpty in interface IConcurrentCollector<DATATYPE>

Returns:

true if the queue is empty, false otherwise.

getQueueLength

@Nonnegative
public final int getQueueLength()

Specified by:

getQueueLength in interface IConcurrentCollector<DATATYPE>

Returns:

The number of objects currently in the queue.

stopQueuingNewObjects

@Nonnull
public final ESuccess stopQueuingNewObjects()

Description copied from interface: IMutableConcurrentCollector

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

Specified by:

stopQueuingNewObjects in interface IMutableConcurrentCollector<DATATYPE>

Returns:

ESuccess

isStopped

public final boolean isStopped()

Description copied from interface: IConcurrentCollector

Check if this collector is already stopped.

Specified by:

isStopped in interface IConcurrentCollector<DATATYPE>

Returns:

true if the collector is stopped, false otherwise.

drainQueue

@Nonnull
 @ReturnsMutableCopy
public final List<DATATYPE> drainQueue()