com.blacklocus.qs

Class AbstractQueueItemHandler<Q,T,R>

java.lang.Object

com.blacklocus.qs.AbstractQueueItemHandler<Q,T,R>

All Implemented Interfaces:

QueueItemHandler<Q,T,R>

Direct Known Subclasses:

AbstractMessageHandler

public abstract class AbstractQueueItemHandler<Q,T,R>
extends java.lang.Object
implements QueueItemHandler<Q,T,R>

Constructor Summary

Constructors

Constructor and Description
AbstractQueueItemHandler()

Method Summary

Modifier and Type	Method and Description
void	onComplete(Q queueItem, T convertedQueueItem, R result) Called whether the processing results in success or failure on the queue item processing thread.
void	onError(Q queueItem, T convertedQueueItem, java.lang.Throwable throwable) Called when an Exception occurs while processing the given queue item on the queue item processing thread.
void	onSuccess(Q queueItem, T convertedQueueItem, R result) Called when processing completes successfully on the queue item processing thread.
void	withFuture(Q queueItem, java.util.concurrent.Future<org.apache.commons.lang3.tuple.Pair<Q,R>> future) Called after the queue item is retrieved off of the queue and handed off to an Executor for processing.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.blacklocus.qs.QueueItemHandler

convert, process

Constructor Detail

AbstractQueueItemHandler

public AbstractQueueItemHandler()

Method Detail

onSuccess

public void onSuccess(Q queueItem,
                      T convertedQueueItem,
                      R result)

Description copied from interface: QueueItemHandler

Called when processing completes successfully on the queue item processing thread.

Specified by:

onSuccess in interface QueueItemHandler<Q,T,R>

Parameters:

queueItem - the original queue item that was successfully processed

convertedQueueItem - the converted target queue item

result - the result returned from successful queue item handling

onError

public void onError(Q queueItem,
                    T convertedQueueItem,
                    java.lang.Throwable throwable)

Description copied from interface: QueueItemHandler

Called when an Exception occurs while processing the given queue item on the queue item processing thread.

Specified by:

onError in interface QueueItemHandler<Q,T,R>

Parameters:

queueItem - the queue item received

convertedQueueItem - the converted target queue item, may be null if convert failed

throwable - the error that occurred while trying to process the queue item

onComplete

public void onComplete(Q queueItem,
                       T convertedQueueItem,
                       R result)

Description copied from interface: QueueItemHandler

Called whether the processing results in success or failure on the queue item processing thread.

Specified by:

onComplete in interface QueueItemHandler<Q,T,R>

Parameters:

queueItem - the original queue item being handled

convertedQueueItem - the converted target queue item, may be null if convert failed

result - the result returned from successful queue item handling or null if it failed

withFuture

public void withFuture(Q queueItem,
                       java.util.concurrent.Future<org.apache.commons.lang3.tuple.Pair<Q,R>> future)

Description copied from interface: QueueItemHandler

Called after the queue item is retrieved off of the queue and handed off to an Executor for processing. This method will be called on the queue reading thread so if it blocks then it will block all subsequent queue reading. Thus, use caution when your implementation of process() might block for a while.

Specified by:

withFuture in interface QueueItemHandler<Q,T,R>

Parameters:

queueItem - the queue item to be processed

future - the Future created after submitting the handling task to the executor