com.helger.commons.concurrent.collector

Class ConcurrentCollectorSingle<DATATYPE>

java.lang.Object

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

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

Type Parameters:

DATATYPE - The type of the objects in the queue.

All Implemented Interfaces:

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

public class ConcurrentCollectorSingle<DATATYPE>
extends AbstractConcurrentCollector<DATATYPE>

Concurrent collector that performs action on each object separately

Author:

Philip Helger

Field Summary

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
ConcurrentCollectorSingle() Constructor that uses AbstractConcurrentCollector.DEFAULT_MAX_QUEUE_SIZE elements as the maximum queue length.
ConcurrentCollectorSingle(int nMaxQueueSize) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected IThrowingRunnableWithParameter<DATATYPE>	getPerformer()
void	run() Run it.
protected void	setPerformer(IThrowingRunnableWithParameter<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

Constructor Detail

ConcurrentCollectorSingle

public ConcurrentCollectorSingle()

Constructor that uses AbstractConcurrentCollector.DEFAULT_MAX_QUEUE_SIZE elements as the maximum queue length.

ConcurrentCollectorSingle

public ConcurrentCollectorSingle(@Nonnegative
                         int nMaxQueueSize)

Constructor.

Parameters:

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

Method Detail

getPerformer

@Nullable
protected final IThrowingRunnableWithParameter<DATATYPE> getPerformer()

Returns:

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

setPerformer

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