net.anotheria.util.queue

Class QueuedProcessor<T>

java.lang.Object

java.lang.Thread

net.anotheria.util.queue.QueuedProcessor<T>

All Implemented Interfaces:

Runnable

public class QueuedProcessor<T>
extends Thread

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEF_QUEUE_SIZE Default queue size.
static long	DEF_SLEEP_TIME Default time to sleep.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
QueuedProcessor(String aName, IQueueWorker<T> aWorker) Shortest queued processor constructor.
QueuedProcessor(String aName, IQueueWorker<T> aWorker, int aQueueSize, org.slf4j.Logger aLog) Creates a new QueuedProcessor.
QueuedProcessor(String aName, IQueueWorker<T> aWorker, int aQueueSize, long aSleepTime, org.slf4j.Logger aLog) Creates a new QueuedProcessor.
QueuedProcessor(String aName, IQueueWorker<T> aWorker, IQueueFactory<T> aQueueFactory) Creates a new QueuedProcessor.
QueuedProcessor(String aName, IQueueWorker<T> aWorker, IQueueFactory<T> aQueueFactory, int aQueueSize, long aSleepTime, org.slf4j.Logger aLog) Creates a new QueuedProcessor.
QueuedProcessor(String aName, IQueueWorker<T> aWorker, IQueueFactory<T> aQueueFactory, org.slf4j.Logger aLog) Creates a new QueuedProcessor.
QueuedProcessor(String aName, IQueueWorker<T> aWorker, org.slf4j.Logger aLog) Creates a new QueuedProcessor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToQueue(T aElement) Default method to add an element to the queue.
void	addToQueueAndWait(T element) Inserts the specified element at the tail of the processing queue, waiting if necessary for space in the queue to become available
void	addToQueueDontWait(T aElement) Inserts the specified element at the tail of the processing queue if the queue is not full
IQueueFactory<T>	getQueueFactory()
int	getQueueOverflowCount()
int	getQueueSize()
String	getStatsString()
int	getThrowAwayCount()
boolean	isStopped()
void	logOutInfo()
void	reset() Resets the queue.
void	run()
void	setQueueFactory(IQueueFactory<T> queueFactory)
void	stopImmediately() Sends signal to stop the QueueProcessor running Thread after working current element.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

DEF_SLEEP_TIME

public static final long DEF_SLEEP_TIME

Default time to sleep.

See Also:

Constant Field Values

DEF_QUEUE_SIZE

public static final int DEF_QUEUE_SIZE

Default queue size.

See Also:

Constant Field Values

Constructor Detail

QueuedProcessor

public QueuedProcessor(String aName,
               IQueueWorker<T> aWorker,
               IQueueFactory<T> aQueueFactory,
               int aQueueSize,
               long aSleepTime,
               org.slf4j.Logger aLog)

Creates a new QueuedProcessor. This is the standard constructor used by all other constructors.

Parameters:

aName - name of the processor.

aWorker - worker for the queued processor.

aQueueFactory - factory to create the underlying queue.

aQueueSize - size of the queue.

aSleepTime - sleep time in case of an overflow.

aLog - logger for output.

QueuedProcessor

public QueuedProcessor(String aName,
               IQueueWorker<T> aWorker,
               IQueueFactory<T> aQueueFactory,
               org.slf4j.Logger aLog)

Creates a new QueuedProcessor. Uses DEF_QUEUE_SIZE and DEF_SLEEP_TIME.

Parameters:

aName - name of the processor.

aWorker - worker for the queued processor.

aQueueFactory - factory to create the underlying queue.

aLog - logger for output.

QueuedProcessor

public QueuedProcessor(String aName,
               IQueueWorker<T> aWorker,
               int aQueueSize,
               long aSleepTime,
               org.slf4j.Logger aLog)

Creates a new QueuedProcessor. Uses DEF_QUEUE_FACTORY.

Parameters:

aName - name of the processor.

aWorker - worker for the queued processor.

aQueueSize - size of the queue.

aSleepTime - sleep time in case of an overflow.

aLog - logger for output.

QueuedProcessor

public QueuedProcessor(String aName,
               IQueueWorker<T> aWorker,
               int aQueueSize,
               org.slf4j.Logger aLog)

Creates a new QueuedProcessor. Uses DEF_QUEUE_FACTORY and DEF_SLEEP_TIME.

Parameters:

aName - name of the processor.

aWorker - worker for the queued processor.

aQueueSize - size of the queue.

aLog - logger for output.

QueuedProcessor

public QueuedProcessor(String aName,
               IQueueWorker<T> aWorker,
               org.slf4j.Logger aLog)

Creates a new QueuedProcessor. Uses DEF_QUEUE_FACTORY, DEF_QUEUE_SIZE and DEF_SLEEP_TIME.

Parameters:

aName - name of the processor.

aWorker - worker for the queued processor.

aLog - logger for output.

QueuedProcessor

public QueuedProcessor(String aName,
               IQueueWorker<T> aWorker,
               IQueueFactory<T> aQueueFactory)

Creates a new QueuedProcessor. Uses DEF_SLEEP_TIME, DEF_QUEUE_SIZE and default logger.

Parameters:

aName - name of the processor.

aWorker - worker for the queued processor.

QueuedProcessor

public QueuedProcessor(String aName,
               IQueueWorker<T> aWorker)

Shortest queued processor constructor. Creates a new QueuedProcessor. Uses DEF_SLEEP_TIME, DEF_QUEUE_SIZE, DEF_QUEUE_FACTORY and default logger.

Parameters:

aName - name of the processor.

aWorker - worker for the queued processor.

Method Detail

reset

public void reset()

Resets the queue. Useful for inittesting. Doesn't restart the processor but deletes the underlying queue. The elements stuck in queue will NOT be delivered.

addToQueueAndWait

public void addToQueueAndWait(T element)

Inserts the specified element at the tail of the processing queue, waiting if necessary for space in the queue to become available

Parameters:

element - the element to add

addToQueue

public void addToQueue(T aElement)
                throws UnrecoverableQueueOverflowException

Default method to add an element to the queue. Calls addToQueueDontWait internally.

Parameters:

aElement -

Throws:

UnrecoverableQueueOverflowException - if the processing queue is full.

addToQueueDontWait

public void addToQueueDontWait(T aElement)
                        throws UnrecoverableQueueOverflowException

Inserts the specified element at the tail of the processing queue if the queue is not full

Parameters:

aElement -

Throws:

UnrecoverableQueueOverflowException - if the processing queue is full.

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

stopImmediately

public void stopImmediately()

Sends signal to stop the QueueProcessor running Thread after working current element.

isStopped

public boolean isStopped()

Returns:

true if processing was stopped by calling stopAfterQueueProcessing() or stopImmediately().

getQueueOverflowCount

public int getQueueOverflowCount()

Returns:

getQueueSize

public int getQueueSize()

getThrowAwayCount

public int getThrowAwayCount()

Returns:

getStatsString

public String getStatsString()

logOutInfo

public void logOutInfo()

getQueueFactory

public IQueueFactory<T> getQueueFactory()

setQueueFactory

public void setQueueFactory(IQueueFactory<T> queueFactory)