io.jmix.ui.executor

Interface TaskLifeCycle<T>

Type Parameters:

T - task progress measurement unit

public interface TaskLifeCycle<T>

Lifecycle object that is passed to BackgroundTask.run(TaskLifeCycle) method to allow working thread to interact with the execution environment.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getParams()
boolean	isCancelled()
boolean	isInterrupted()
void	publish(T... changes) Publish changes to show progress.

Method Detail

publish

void publish(T... changes)
      throws java.lang.InterruptedException

Publish changes to show progress.

Parameters:

changes - Changes

Throws:

java.lang.InterruptedException - if task was interrupted by calling BackgroundTaskHandler.cancel()

isInterrupted

boolean isInterrupted()

Returns:

true if the working thread has been interrupted

isCancelled

boolean isCancelled()

Returns:

true if a task was interrupted by calling the "cancel" method

getParams

java.util.Map<java.lang.String,java.lang.Object> getParams()

Returns:

execution parameters that was set by BackgroundTask.getParams()