us.fatehi.utility.scheduler

Interface TaskRunner

All Superinterfaces:

AutoCloseable

public interface TaskRunner
extends AutoCloseable

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_THREADS
static int	MIN_THREADS

Method Summary

Modifier and Type	Method and Description
void	add(TaskDefinition taskDefinition) Add a task definition to the list of tasks to run.
default void	close() Alias for stop for use in a try-catch block.
String	getId() Id of this task runner.
boolean	isStopped() Returns true if the task runner is stopped and is not accepting any more tasks.
Supplier<String>	report() Allows for a deferred conversion to a string.
void	stop() Stop the task runner after waiting for all the threads to finish executing.
void	submit() Submit the current list of tasks for execution, and block until execution is complete.

Field Detail

MIN_THREADS

static final int MIN_THREADS

See Also:

Constant Field Values

MAX_THREADS

static final int MAX_THREADS

See Also:

Constant Field Values

Method Detail

add

void add(TaskDefinition taskDefinition)
  throws Exception

Add a task definition to the list of tasks to run.

Throws:

Exception

close

default void close()
            throws Exception

Alias for stop for use in a try-catch block.

Specified by:

close in interface AutoCloseable

Throws:

Exception

getId

String getId()

Id of this task runner.

Returns:

Id of task runner.

isStopped

boolean isStopped()

Returns true if the task runner is stopped and is not accepting any more tasks.

Returns:

True if stopped.

report

Supplier<String> report()

Allows for a deferred conversion to a string. Useful in logging.

Returns:

String supplier.

Throws:

Exception

stop

void stop()

Stop the task runner after waiting for all the threads to finish executing. No more tasks will be accepted.

Throws:

ExecutionException - On an exception.

submit

void submit()
     throws Exception

Submit the current list of tasks for execution, and block until execution is complete. Then clears the task list.

Throws:

Exception - On an exception in any one of the tasks.