Package 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:

IConcurrentCollector, IMutableConcurrentCollector<DATATYPE>

Direct Known Subclasses:

ConcurrentCollectorMultiple, ConcurrentCollectorSingle

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

Abstract concurrent collector based on BlockingQueue.

Author:

Philip Helger

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final ICommonsList<DATATYPE>	drainQueue()
final int	getQueueLength()
boolean	isQueueEmpty()
final boolean	isStopped()	Check if this collector is already stopped.
final ESuccess	queueObject(DATATYPE aObject)	Submit an object to the queue.
final 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.concurrent.collector.IMutableConcurrentCollector

collect

Field Details

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. Should implement Comparable for the priority queue

m_aQueue

protected final BlockingQueue<Object> m_aQueue

Constructor Details

AbstractConcurrentCollector

protected 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

protected AbstractConcurrentCollector(@Nonnull
 BlockingQueue<Object> aQueue)

Constructor using an arbitrary BlockingQueue.

Parameters:

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

Method Details

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

Returns:

true if the queue is empty, false otherwise.

getQueueLength

@Nonnegative
public final int getQueueLength()

Specified by:

getQueueLength in interface IConcurrentCollector

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

Returns:

true if the collector is stopped, false otherwise.

drainQueue

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