Package org.omegazero.common.event

Class DelegatingTaskQueueExecutor

java.lang.Object

org.omegazero.common.event.AbstractTaskQueueExecutor

org.omegazero.common.event.DelegatingTaskQueueExecutor

public class DelegatingTaskQueueExecutor
extends AbstractTaskQueueExecutor

An AbstractTaskQueueExecutor delegating all tasks to another AbstractTaskQueueExecutor implementation.

This class is thread-safe.

Since:

2.12.0

Constructor Summary

Constructors

Constructor	Description
DelegatingTaskQueueExecutor(AbstractTaskQueueExecutor delegate)	Creates a new DelegatingTaskQueueExecutor.

Method Summary

Modifier and Type	Method	Description
boolean	exit(boolean blocking)	Shuts this AbstractTaskQueueExecutor down by gracefully stopping the worker threads.
AbstractTaskQueueExecutor	getDelegate()	Returns the currently set AbstractTaskQueueExecutor to delegate tasks to.
void	lock()	Locks this DelegatingTaskQueueExecutor.
boolean	queue(Task task)	Queues a task to be executed by any available worker thread.
void	setDelegate(AbstractTaskQueueExecutor delegate)	Sets a new AbstractTaskQueueExecutor to delegate tasks to.
void	setErrorHandler(Consumer<Throwable> errorHandler)	Sets the error handler that will be called when an error occurs while executing a task in any of the worker threads.
boolean	unqueue(Task task)	Removes the given task from the queue.

Methods inherited from class org.omegazero.common.event.AbstractTaskQueueExecutor

exit, queue, queue, queue

Methods inherited from class java.lang.Object

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

Constructor Details

DelegatingTaskQueueExecutor

public DelegatingTaskQueueExecutor(AbstractTaskQueueExecutor delegate)

Creates a new DelegatingTaskQueueExecutor.

Parameters:

delegate - The AbstractTaskQueueExecutor to delegate tasks to

Method Details

getDelegate

public AbstractTaskQueueExecutor getDelegate()

Returns the currently set AbstractTaskQueueExecutor to delegate tasks to.

Returns:

The current delegate

setDelegate

public void setDelegate(AbstractTaskQueueExecutor delegate)

Sets a new AbstractTaskQueueExecutor to delegate tasks to.

Parameters:

delegate - The new AbstractTaskQueueExecutor

Throws:

IllegalStateException - If this DelegatingTaskQueueExecutor was locked using lock()

lock

public void lock()

Locks this DelegatingTaskQueueExecutor. If locked, the delegate cannot be changed using setDelegate(AbstractTaskQueueExecutor) anymore.

Throws:

IllegalStateException - If this DelegatingTaskQueueExecutor was locked already

queue

public boolean queue(Task task)

Description copied from class: AbstractTaskQueueExecutor

Queues a task to be executed by any available worker thread.

Specified by:

queue in class AbstractTaskQueueExecutor

Parameters:

task - The task to queue

Returns:

true if the task was successfully queued

See Also:

• AbstractTaskQueueExecutor.unqueue(Task)

unqueue

public boolean unqueue(Task task)

Description copied from class: AbstractTaskQueueExecutor

Removes the given task from the queue.

Specified by:

unqueue in class AbstractTaskQueueExecutor

Parameters:

task - The task to remove

Returns:

true if the task was queued previously and removed successfully

See Also:

• AbstractTaskQueueExecutor.queue(Task)
• Collection.remove(Object)

exit

public boolean exit(boolean blocking)

Description copied from class: AbstractTaskQueueExecutor

Shuts this AbstractTaskQueueExecutor down by gracefully stopping the worker threads.

Specified by:

exit in class AbstractTaskQueueExecutor

Parameters:

blocking - true to wait for all worker threads to exit

Returns:

true if the calling thread was interrupted while waiting for the worker threads to exit

setErrorHandler

public void setErrorHandler(Consumer<Throwable> errorHandler)

Description copied from class: AbstractTaskQueueExecutor

Sets the error handler that will be called when an error occurs while executing a task in any of the worker threads.

If this handler is not set, the error will be printed to stderr.

Specified by:

setErrorHandler in class AbstractTaskQueueExecutor

Parameters:

errorHandler - The error handler, or null to remove an existing error handler