io.jmix.ui.executor

Interface BackgroundTaskHandler<V>

All Known Implementing Classes:

TaskHandlerImpl

public interface BackgroundTaskHandler<V>

Task handler for BackgroundTask.

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Cancel task.
void	execute() Execute the BackgroundTask.
V	getResult() Wait for the task completion and return its result.
boolean	isAlive()
boolean	isCancelled()
boolean	isDone()

Method Detail

execute

void execute()

Execute the BackgroundTask.
This method must be called only once for a handler instance.

cancel

boolean cancel()

Cancel task.

Returns:

true if canceled, false if the task was not started or is already stopped

getResult

@Nullable
V getResult()

Wait for the task completion and return its result.

Returns:

task's result returned from BackgroundTask.run(TaskLifeCycle) method

isDone

boolean isDone()

Returns:

true if the task is completed

isCancelled

boolean isCancelled()

Returns:

true if the task has been canceled

isAlive

boolean isAlive()

Returns:

true if the task is running