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:

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

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 and 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 and 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.

Method Summary

Methods

Modifier and Type	Method and Description
protected IThrowingRunnableWithParameter<List<DATATYPE>>	getPerformer()
void	run() Run it.
protected void	setPerformer(IThrowingRunnableWithParameter<List<DATATYPE>> aPerformer) Set the performer to be used.

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

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.

Method Detail

getPerformer

@Nullable
protected final IThrowingRunnableWithParameter<List<DATATYPE>> getPerformer()

Returns:

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

setPerformer

protected final void setPerformer(@Nonnull
                IThrowingRunnableWithParameter<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.

Throws:

IllegalStateException - If another performer is already present!

run

public final void run()

Description copied from interface: INonThrowingRunnable

Run it.