Package org.evolvis.tartools.backgroundjobs

Interface BackgroundJobStatus<T>

Type Parameters:

T -

All Superinterfaces:

BackgroundJobInfo

All Known Implementing Classes:

BackgroundJobStatusDecorator

public interface BackgroundJobStatus<T>
extends BackgroundJobInfo

A handle on a scheduled BackgroundJob.

This interface extends the BackgroundJobInfo contract by adding methods to abort() or join(long) a scheduled job, and to obtain its result() once it is done.

Author:

lukas

Nested Class Summary

Nested classes/interfaces inherited from interface org.evolvis.tartools.backgroundjobs.BackgroundJobInfo

BackgroundJobInfo.State

Method Summary

Modifier and Type	Method	Description
void	abort()	Request the cancellation of a job.
void	addJobListener(JobListener l)
boolean	isCancellationSupported()	Whether this job can be canceled.
void	join(long timeout)	Join the thread executing the job.
void	removeJobListener(JobListener l)
T	result()	Obtain the result produced by the job, waiting for its completion if necessary.

Methods inherited from interface org.evolvis.tartools.backgroundjobs.BackgroundJobInfo

getDescription, getId, getJobClass, getLastModified, getStartTime, getState, getWorkDone, getWorkTotal, isVisible

Method Details

abort

void abort()

Request the cancellation of a job.

This will try to interrupt the thread executing the job and it will make BackgroundJobMonitor.isAborting() return false. Nevertheless it may take some time until the job actually stops whatever it is doing.

join

void join(long timeout)
   throws InterruptedException

Join the thread executing the job.

Parameters:

timeout - the maximum number of milliseconds to wait for the job.

Throws:

InterruptedException

result

T result()
  throws InterruptedException,
ExecutionException

Obtain the result produced by the job, waiting for its completion if necessary.

Returns:

the result.

Throws:

InterruptedException

ExecutionException

isCancellationSupported

boolean isCancellationSupported()

Whether this job can be canceled.

Returns:

a boolean indicating whether this job can be canceled once its execution has started.

Since:

1.21

See Also:

• BackgroundJob.isCancellationSupported()

addJobListener

void addJobListener(JobListener l)

removeJobListener

void removeJobListener(JobListener l)