io.jmix.ui.executor.impl

Class TaskHandlerImpl<T,V>

java.lang.Object

io.jmix.ui.executor.impl.TaskHandlerImpl<T,V>

All Implemented Interfaces:

BackgroundTaskHandler<V>

public class TaskHandlerImpl<T,V>
extends java.lang.Object
implements BackgroundTaskHandler<V>

Constructor Summary

Constructors

Constructor and Description
TaskHandlerImpl(UIAccessor uiAccessor, TaskExecutor<T,V> taskExecutor, WatchDog watchDog, org.springframework.context.ApplicationEventPublisher applicationEventPublisher, org.springframework.security.core.userdetails.UserDetails user, io.jmix.core.TimeSource timeSource)

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Cancel task.
void	closeByTimeout() Cancel without events for tasks.
void	execute() Execute the BackgroundTask.
V	getResult() Join task thread to current Caution! Call this method only from synchronous gui action ;
long	getStartTimeStamp()
BackgroundTask<T,V>	getTask()
long	getTimeoutMs()
boolean	isAlive()
boolean	isCancelled()
boolean	isDone()
void	kill() Cancel without events for tasks
protected void	ownerWindowRemoved(FrameOwner frameOwner)
protected void	removeAfterDetachListener()
void	timeoutExceeded() Cancel with timeout exceeded event

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskHandlerImpl

public TaskHandlerImpl(UIAccessor uiAccessor,
                       TaskExecutor<T,V> taskExecutor,
                       WatchDog watchDog,
                       org.springframework.context.ApplicationEventPublisher applicationEventPublisher,
                       org.springframework.security.core.userdetails.UserDetails user,
                       io.jmix.core.TimeSource timeSource)

Method Detail

ownerWindowRemoved

protected void ownerWindowRemoved(FrameOwner frameOwner)

execute

public final void execute()

Description copied from interface: BackgroundTaskHandler

Execute the BackgroundTask.
This method must be called only once for a handler instance.

Specified by:

execute in interface BackgroundTaskHandler<V>

cancel

public final boolean cancel()

Description copied from interface: BackgroundTaskHandler

Cancel task.

Specified by:

cancel in interface BackgroundTaskHandler<V>

Returns:

true if canceled, false if the task was not started or is already stopped

removeAfterDetachListener

protected void removeAfterDetachListener()

getResult

@Nullable
public final V getResult()

Join task thread to current
Caution! Call this method only from synchronous gui action ;

Specified by:

getResult in interface BackgroundTaskHandler<V>

Returns:

Task result

closeByTimeout

public final void closeByTimeout()

Cancel without events for tasks. Need to execute #timeoutExceeded after this method

kill

public final void kill()

Cancel without events for tasks

timeoutExceeded

public final void timeoutExceeded()

Cancel with timeout exceeded event

isDone

public final boolean isDone()

Specified by:

isDone in interface BackgroundTaskHandler<V>

Returns:

true if the task is completed

isCancelled

public final boolean isCancelled()

Specified by:

isCancelled in interface BackgroundTaskHandler<V>

Returns:

true if the task has been canceled

isAlive

public final boolean isAlive()

Specified by:

isAlive in interface BackgroundTaskHandler<V>

Returns:

true if the task is running

getTask

public final BackgroundTask<T,V> getTask()

getStartTimeStamp

public long getStartTimeStamp()

getTimeoutMs

public long getTimeoutMs()