Package com.helger.commons.concurrent.collector

Class ConcurrentCollectorMultiple<DATATYPE>

java.lang.Object

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

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

Type Parameters:

DATATYPE - The type of the objects in the queue.

All Implemented Interfaces:

IConcurrentCollector, IMutableConcurrentCollector<DATATYPE>

public class ConcurrentCollectorMultiple<DATATYPE>
extends AbstractConcurrentCollector<DATATYPE>

Concurrent collector that performs action on multiple objects at once

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_MAX_PERFORM_COUNT	The default number of objects to be put in the queue for execution.

Fields inherited from class com.helger.commons.concurrent.collector.AbstractConcurrentCollector

DEFAULT_MAX_QUEUE_SIZE, m_aQueue, STOP_QUEUE_OBJECT

Constructor Summary

Constructors

Constructor	Description
ConcurrentCollectorMultiple()	Constructor that uses AbstractConcurrentCollector.DEFAULT_MAX_QUEUE_SIZE elements as the maximum queue length and DEFAULT_MAX_PERFORM_COUNT as the max perform count.
ConcurrentCollectorMultiple(int nMaxQueueSize, int nMaxPerformCount)	Constructor.
ConcurrentCollectorMultiple(BlockingQueue<Object> aQueue)	Constructor using an existing BlockingQueue and the default max perform count (50).
ConcurrentCollectorMultiple(BlockingQueue<Object> aQueue, int nMaxPerformCount)	Constructor using an existing BlockingQueue.

Method Summary

Modifier and Type	Method	Description
void	collect()	This method starts the collector by taking objects from the internal BlockingQueue.
int	getMaxPerformCount()
IConcurrentPerformer<List<DATATYPE>>	getPerformer()
ConcurrentCollectorMultiple<DATATYPE>	setPerformer(IConcurrentPerformer<List<DATATYPE>> aPerformer)	Set the performer to be used.

Methods inherited from class com.helger.commons.concurrent.collector.AbstractConcurrentCollector

drainQueue, getQueueLength, isQueueEmpty, isStopped, queueObject, stopQueuingNewObjects

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_PERFORM_COUNT

public static final int DEFAULT_MAX_PERFORM_COUNT

The default number of objects to be put in the queue for execution.

See Also:

Constant Field Values

Constructor Detail

ConcurrentCollectorMultiple

public ConcurrentCollectorMultiple()

Constructor that uses AbstractConcurrentCollector.DEFAULT_MAX_QUEUE_SIZE elements as the maximum queue length and DEFAULT_MAX_PERFORM_COUNT as the max perform count.

ConcurrentCollectorMultiple

public ConcurrentCollectorMultiple(@Nonnegative
                                   int nMaxQueueSize,
                                   @Nonnegative
                                   int nMaxPerformCount)

Constructor.

Parameters:

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

nMaxPerformCount - The maximum number of objects to be put in the queue for execution. Must be > 0.

ConcurrentCollectorMultiple

public ConcurrentCollectorMultiple(@Nonnull
                                   BlockingQueue<Object> aQueue)

Constructor using an existing BlockingQueue and the default max perform count (50).

Parameters:

aQueue - BlockingQueue to use. May not be null.

ConcurrentCollectorMultiple

public ConcurrentCollectorMultiple(@Nonnull
                                   BlockingQueue<Object> aQueue,
                                   @Nonnegative
                                   int nMaxPerformCount)

Constructor using an existing BlockingQueue.

Parameters:

aQueue - BlockingQueue to use. May not be null.

nMaxPerformCount - The maximum number of objects to be put in the list for execution. Must be > 0.

Method Detail

getMaxPerformCount

@Nonnegative
public final int getMaxPerformCount()

Returns:

The maximum number of objects to be put in the list for execution. Always ≥ 0.

getPerformer

@Nullable
public final IConcurrentPerformer<List<DATATYPE>> getPerformer()

Returns:

The current performer set. null if none was explicitly set.

setPerformer

@Nonnull
public final ConcurrentCollectorMultiple<DATATYPE> setPerformer(@Nonnull
                                                                IConcurrentPerformer<List<DATATYPE>> aPerformer)

Set the performer to be used. This method must be invoked before the collector can be run. The passed implementation must be rock-solid as this class will not make any retries. If the passed performer throws and exception without handling the objects correct the objects will be lost!

Parameters:

aPerformer - The performer to be used. May not be null.

Returns:

this for chaining

Throws:

IllegalStateException - If another performer is already present!

collect

public final void collect()

This method starts the collector by taking objects from the internal BlockingQueue. So this method blocks and must be invoked from a separate thread. This method runs until AbstractConcurrentCollector.stopQueuingNewObjects() is new called and the queue is empty.

Throws:

IllegalStateException - if no performer is set - see setPerformer(IConcurrentPerformer)