BackgroundWorker (Jmix-all 1.5 API)

All Known Implementing Classes:: WebBackgroundWorker

public interface BackgroundWorker

Entry point to BackgroundTask execution functionality.

Method Summary

Modifier and Type

Method

Description

void

checkUIAccess()

UIAccessor

getUIAccessor()

Obtain UI access for later use from background thread.

<T, V> BackgroundTaskHandler<V>

handle(BackgroundTask<T,V> task)

Create handler for a background task.

Method Details
- handle
  
  <T, V> BackgroundTaskHandler<V> handle(BackgroundTask<T,V> task)
  
  Create handler for a background task. The handler is used to control the task execution.
  
  Type Parameters:
  
  T - progress measure unit
  
  V - task result type
  
  Parameters:
  
  task - background task instance
  
  Returns:
  
  task handler
  
  Throws:
  
  IllegalConcurrentAccessException - in case of call from non UI thread
- getUIAccessor
  
  UIAccessor getUIAccessor()
  
  Obtain UI access for later use from background thread. Can be invoked only from UI thread.
  
  Returns:
  
  ui accessor object that allows to read/write state of UI
  
  Throws:
  
  IllegalConcurrentAccessException - in case of call from non UI thread
- checkUIAccess
  
  void checkUIAccess()
  
  Throws:
  
  IllegalConcurrentAccessException - in case of call from non UI thread