au.com.cybersearch2.classytask

Class TaskRunner

java.lang.Object

au.com.cybersearch2.classytask.Executable

au.com.cybersearch2.classytask.TaskRunner

public class TaskRunner
extends Executable

TaskRunner

Author:

Andrew Bowley 8 Jan 2016

Constructor Summary

Constructors

Constructor and Description
TaskRunner(TaskManager taskManager, TaskMessenger taskMessenger) Construct TaskRunner object

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning) Attempts to cancel execution of this task.
Executable	execute(BackgroundTask backgroundTask) Executes the worker task.
WorkStatus	getStatus() Returns task status
boolean	isCancelled() Returns true if this task was cancelled before it completed normally.

Methods inherited from class au.com.cybersearch2.classytask.Executable

waitForTask

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskRunner

public TaskRunner(TaskManager taskManager,
          TaskMessenger taskMessenger)

Construct TaskRunner object

Parameters:

taskManager - Manages the thread pool

taskMessenger - Post inter-thread messages

Method Detail

getStatus

public WorkStatus getStatus()

Returns task status

Specified by:

getStatus in class Executable

Returns:

WorkStatus

execute

public final Executable execute(BackgroundTask backgroundTask)

Executes the worker task. Any required parameters will need to be provided as fields belonging to the sub class. The task returns itself (this) so that the caller can keep a reference to it.

Parameters:

backgroundTask - Task to run

Returns:

Executable to track status

Throws:

IllegalStateException - If status is either WorkStatus.RUNNING or WorkStatus.FINISHED.

cancel

public final boolean cancel(boolean mayInterruptIfRunning)

Attempts to cancel execution of this task. This attempt will fail if the task has already completed, already been cancelled, or could not be cancelled for some other reason. If successful, and this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task should be interrupted in an attempt to stop the task.

Parameters:

mayInterruptIfRunning - true if the thread executing this task should be interrupted; otherwise, in-progress tasks are allowed to complete.

Returns:

false if the task could not be cancelled, typically because it has already completed normally; true otherwise

See Also:

isCancelled(), BackgroundTask.onCancelled(Boolean)

isCancelled

public final boolean isCancelled()

Returns true if this task was cancelled before it completed normally.

Returns:

boolean

See Also:

cancel(boolean)