Package io.jmix.imapui.screen.message

Class ImapMessageEdit.InitBodyTask

java.lang.Object

io.jmix.ui.executor.BackgroundTask<Integer,ImapMessageDto>

io.jmix.imapui.screen.message.ImapMessageEdit.InitBodyTask

Enclosing class:

ImapMessageEdit

protected class ImapMessageEdit.InitBodyTask
extends BackgroundTask<Integer,ImapMessageDto>

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.executor.BackgroundTask

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final AtomicInteger	loadProgress
protected final ImapMessage	message

Method Summary

Modifier and Type	Method	Description
void	canceled()	Called by the execution environment in UI thread if the task is canceled by BackgroundTaskHandler.cancel() invocation.
void	done(ImapMessageDto dto)	Called by the execution environment in UI thread when the task is completed.
void	progress(List<Integer> changes)	Called by the execution environment in UI thread on progress change.
ImapMessageDto	run(TaskLifeCycle<Integer> taskLifeCycle)	Main method that performs a task.

Methods inherited from class io.jmix.ui.executor.BackgroundTask

addProgressListener, getOwnerFrame, getOwnerScreen, getParams, getProgressListeners, getTimeoutMilliseconds, getTimeoutSeconds, handleException, handleTimeoutException, removeProgressListener

Methods inherited from class java.lang.Object

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

Field Details

message

protected final ImapMessage message

loadProgress

protected final AtomicInteger loadProgress

Method Details

run

public ImapMessageDto run(TaskLifeCycle<Integer> 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<Integer,ImapMessageDto>

Parameters:

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

Returns:

task result

canceled

public void canceled()

Description copied from class: BackgroundTask

Called by the execution environment in UI thread if the task is canceled by BackgroundTaskHandler.cancel() invocation.
This method is not called in case of timeout expiration or owner window closing.

Overrides:

canceled in class BackgroundTask<Integer,ImapMessageDto>

done

public void done(ImapMessageDto dto)

Description copied from class: BackgroundTask

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

Overrides:

done in class BackgroundTask<Integer,ImapMessageDto>

Parameters:

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

progress

public void progress(List<Integer> changes)

Description copied from class: BackgroundTask

Called by the execution environment in UI thread on progress change.

Overrides:

progress in class BackgroundTask<Integer,ImapMessageDto>

Parameters:

changes - list of changes since previous invocation