org.iota.jota.utils.thread

Interface ReportingExecutorService

All Known Implementing Classes:

BoundedScheduledExecutorService, DedicatedScheduledExecutorService, UnboundScheduledExecutorService

public interface ReportingExecutorService

This interface defines a contract for ExecutorServices that makes them call a "reporting" method whenever an important event occurs.

This way a child class extending these kind of ExecutorServices can "hook" into these events by overriding the specific method and add additional logic like logging or debugging capabilities.

Method Summary

Modifier and Type	Method and Description
void	onCancelTask(TaskDetails taskDetails) This method gets called whenever a task is cancelled through its Future or through the shutdown methods of the ExecutorService. It only gets called once for every task.
void	onCompleteTask(TaskDetails taskDetails, Throwable error) This method gets called whenever a task completes. This can be through either raising an exception, cancelling from the outside or by simply terminating in a normal manner.
void	onFinishTask(TaskDetails taskDetails, Throwable error) This method gets called whenever a task is finished. For recurring tasks it is called multiple times.
void	onScheduleTask(TaskDetails taskDetails) This method gets called whenever a new task is scheduled to run. In contrast to onStartTask(TaskDetails) this method gets called only once for "recurring" tasks that are scheduled to run in pre-defined intervals.
void	onStartTask(TaskDetails taskDetails) This method gets called whenever a task is started. For recurring tasks it is called multiple times.

Method Detail

onScheduleTask

void onScheduleTask(TaskDetails taskDetails)

This method gets called whenever a new task is scheduled to run.

In contrast to onStartTask(TaskDetails) this method gets called only once for "recurring" tasks that are scheduled to run in pre-defined intervals.

Parameters:

taskDetails - object containing details about this task

onStartTask

void onStartTask(TaskDetails taskDetails)

This method gets called whenever a task is started.

For recurring tasks it is called multiple times.

Parameters:

taskDetails - object containing details about this task

onFinishTask

void onFinishTask(TaskDetails taskDetails,
                  Throwable error)

This method gets called whenever a task is finished.

For recurring tasks it is called multiple times.

Parameters:

taskDetails - object containing details about this task

error - Exception that caused the task to complete

onCancelTask

void onCancelTask(TaskDetails taskDetails)

This method gets called whenever a task is cancelled through its Future or through the shutdown methods of the ExecutorService.

It only gets called once for every task.

Parameters:

taskDetails - object containing details about this task

onCompleteTask

void onCompleteTask(TaskDetails taskDetails,
                    Throwable error)

This method gets called whenever a task completes.

This can be through either raising an exception, cancelling from the outside or by simply terminating in a normal manner. For recurring tasks this only gets called once.

Parameters:

taskDetails - object containing details about this task

error - Exception that caused the task to complete