Package io.jmix.jmxconsole.view

Class MBeanOperationResultView.OperationBackgroundTask

java.lang.Object

io.jmix.flowui.backgroundtask.BackgroundTask<Long,Object>

io.jmix.jmxconsole.view.MBeanOperationResultView.OperationBackgroundTask

Enclosing class:

MBeanOperationResultView

protected class MBeanOperationResultView.OperationBackgroundTask
extends BackgroundTask<Long,Object>

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.flowui.backgroundtask.BackgroundTask

BackgroundTask.ProgressListener<T,V>, BackgroundTask.ProgressListenerAdapter<T,V>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OperationBackgroundTask(long timeoutSeconds, View<?> view)

Method Summary

Modifier and Type	Method	Description
void	done(Object res)	Called by the execution environment in UI thread when the task is completed.
boolean	handleException(Exception ex)	Called by the execution environment in UI thread if the task BackgroundTask.run(TaskLifeCycle) method raised an exception.
boolean	handleTimeoutException()	Called by the execution environment in UI thread if the task timeout is exceeded.
Object	run(TaskLifeCycle<Long> taskLifeCycle)	Main method that performs a task.
protected void	showResult(String resultMessage)

Methods inherited from class io.jmix.flowui.backgroundtask.BackgroundTask

addProgressListener, canceled, getOwnerView, getParams, getProgressListeners, getTimeoutMilliseconds, getTimeoutSeconds, progress, removeProgressListener

Methods inherited from class java.lang.Object

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

Constructor Details

OperationBackgroundTask

protected OperationBackgroundTask(long timeoutSeconds,
 View<?> view)

Method Details

run

public Object run(TaskLifeCycle<Long> taskLifeCycle)

Description copied from class: BackgroundTask

Main method that performs a task.
Called by the execution environment in a separate working thread.
Implementation of this method should support interruption:

• In long loops check TaskLifeCycle.isInterrupted() and return if it is true
• Don't swallow InterruptedException - return from the method or don't catch it at all

Specified by:

run in class BackgroundTask<Long,Object>

Parameters:

taskLifeCycle - lifecycle object that allows the main method to interact with the execution environment

Returns:

task result

done

public void done(Object res)

Description copied from class: BackgroundTask

Called by the execution environment in UI thread when the task is completed.

Overrides:

done in class BackgroundTask<Long,Object>

Parameters:

res - result of execution returned by BackgroundTask.run(TaskLifeCycle) method

handleException

public boolean handleException(Exception ex)

Description copied from class: BackgroundTask

Called by the execution environment in UI thread if the task BackgroundTask.run(TaskLifeCycle) method raised an exception.

Overrides:

handleException in class BackgroundTask<Long,Object>

Parameters:

ex - exception

Returns:

true if this method implementation actually handles the exception. Used for chaining handlers.

handleTimeoutException

public boolean handleTimeoutException()

Description copied from class: BackgroundTask

Called by the execution environment in UI thread if the task timeout is exceeded.

Overrides:

handleTimeoutException in class BackgroundTask<Long,Object>

Returns:

true if this method implementation actually handles this event. Used for chaining handlers.

showResult

protected void showResult(String resultMessage)