Package io.jmix.flowui.backgroundtask

Class LocalizedTaskWrapper<T,V>

java.lang.Object

io.jmix.flowui.backgroundtask.BackgroundTask<T,V>

io.jmix.flowui.backgroundtask.LocalizedTaskWrapper<T,V>

Type Parameters:

T - task progress measurement unit

V - result type

@Component("flowui_LocalizedTaskWrapper")
@Scope("prototype")
public class LocalizedTaskWrapper<T,V>
extends BackgroundTask<T,V>

INTERNAL! Supposed to use when showing Dialog or some View. For instance if we need to show some dialog when task is running (e.g. updating the progress).

See example in DialogsImpl.BackgroundTaskDialogBuilderImpl.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LocalizedTaskWrapper.CloseViewContext

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

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

Field Summary

Fields

Modifier and Type	Field	Description
protected Consumer<LocalizedTaskWrapper.CloseViewContext>	closeViewHandler
protected Messages	messages
protected Notifications	notifications
protected BackgroundTask<T,V>	wrappedTask

Constructor Summary

Constructors

Constructor	Description
LocalizedTaskWrapper(BackgroundTask<T,V> wrappedTask)

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(V result)	Called by the execution environment in UI thread when the task is completed.
Consumer<LocalizedTaskWrapper.CloseViewContext>	getCloseViewHandler()
Map<String,Object>	getParams()	Called by the execution environment in UI thread to prepare some execution parameters.
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.
protected void	notifyCloseViewHandler()
void	progress(List<T> changes)	Called by the execution environment in UI thread on progress change.
V	run(TaskLifeCycle<T> lifeCycle)	Main method that performs a task.
void	setCloseViewHandler(Consumer<LocalizedTaskWrapper.CloseViewContext> closeViewHandler)
void	setMessages(Messages messages)
void	setNotifications(Notifications notifications)
protected void	showExecutionError(Exception ex)

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

addProgressListener, getOwnerView, getProgressListeners, getTimeoutMilliseconds, getTimeoutSeconds, removeProgressListener

Methods inherited from class java.lang.Object

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

Field Details

messages

protected Messages messages

notifications

protected Notifications notifications

wrappedTask

protected BackgroundTask<T,V> wrappedTask

closeViewHandler

protected Consumer<LocalizedTaskWrapper.CloseViewContext> closeViewHandler

Constructor Details

LocalizedTaskWrapper

public LocalizedTaskWrapper(BackgroundTask<T,V> wrappedTask)

Method Details

setMessages

@Autowired
public void setMessages(Messages messages)

setNotifications

@Autowired
public void setNotifications(Notifications notifications)

getCloseViewHandler

@Nullable
public Consumer<LocalizedTaskWrapper.CloseViewContext> getCloseViewHandler()

setCloseViewHandler

public void setCloseViewHandler(@Nullable
 Consumer<LocalizedTaskWrapper.CloseViewContext> closeViewHandler)

getParams

public Map<String,Object> getParams()

Description copied from class: BackgroundTask

Called by the execution environment in UI thread to prepare some execution parameters. These parameters can be requested by the working thread inside the BackgroundTask.run(TaskLifeCycle) method by calling TaskLifeCycle.getParams().

Overrides:

getParams in class BackgroundTask<T,V>

Returns:

parameters map or null if parameters are not needed

run

public V run(TaskLifeCycle<T> lifeCycle)
      throws Exception

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<T,V>

Parameters:

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

Returns:

task result

Throws:

Exception - exception in working thread

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<T,V>

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<T,V>

Returns:

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

done

public void done(V result)

Description copied from class: BackgroundTask

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

Overrides:

done in class BackgroundTask<T,V>

Parameters:

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

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 view closing.

Overrides:

canceled in class BackgroundTask<T,V>

progress

public void progress(List<T> changes)

Description copied from class: BackgroundTask

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

Overrides:

progress in class BackgroundTask<T,V>

Parameters:

changes - list of changes since previous invocation

showExecutionError

protected void showExecutionError(Exception ex)

notifyCloseViewHandler

protected void notifyCloseViewHandler()