Package org.openrefine.runners.local.pll.util

Class ProgressingFutureWrapper<T>

java.lang.Object

org.openrefine.runners.local.pll.util.ProgressingFutureWrapper<T>

All Implemented Interfaces:

com.google.common.util.concurrent.ListenableFuture<T>, Future<T>, ProgressingFuture<T>

public class ProgressingFutureWrapper<T>
extends Object
implements ProgressingFuture<T>

A future which supports pausing and progress reporting, assuming the underlying future was built on a task that relies on the supplied TaskSignalling object to periodically check for pause and report progress.

Constructor Summary

Constructors

Constructor	Description
ProgressingFutureWrapper(com.google.common.util.concurrent.ListenableFuture<T> future, TaskSignalling taskSignalling, boolean supportsProgress)

Method Summary

Modifier and Type	Method	Description
void	addListener(Runnable listener, Executor executor)
boolean	cancel(boolean b)
T	get()
T	get(long l, TimeUnit timeUnit)
int	getProgress()
boolean	isCancelled()
boolean	isDone()
boolean	isPaused()
void	onProgress(ProgressReporter reporter)	Registers a callback to be called every time the progress of this task changes.
void	pause()	Pauses the process that is computing the value to be returned in this future.
void	resume()	Resumes the process that is computing the value to be returned in this future.
boolean	supportsProgress()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressingFutureWrapper

public ProgressingFutureWrapper(com.google.common.util.concurrent.ListenableFuture<T> future,
                                TaskSignalling taskSignalling,
                                boolean supportsProgress)

Method Detail

pause

public void pause()

Description copied from interface: ProgressingFuture

Pauses the process that is computing the value to be returned in this future. If this process is not running, this action has no effect.

Specified by:

pause in interface ProgressingFuture<T>

resume

public void resume()

Description copied from interface: ProgressingFuture

Resumes the process that is computing the value to be returned in this future. If this process had not been paused before, this action has no effect.

Specified by:

resume in interface ProgressingFuture<T>

isPaused

public boolean isPaused()

Specified by:

isPaused in interface ProgressingFuture<T>

Returns:

whether the process is currently paused

supportsProgress

public boolean supportsProgress()

Specified by:

supportsProgress in interface ProgressingFuture<T>

Returns:

whether the underlying process supports reporting progress beyond a boolean status, that is to say whether it can be in progress states strictly between 0 and 100.

getProgress

public int getProgress()

Specified by:

getProgress in interface ProgressingFuture<T>

Returns:

the current progress percentage of the task, between 0 and 100. If the task does not support reporting progress, this returns 0 until the task is successful, after which it returns 100. If the task results in an error, the progress might not reach 100.

onProgress

public void onProgress(ProgressReporter reporter)

Description copied from interface: ProgressingFuture

Registers a callback to be called every time the progress of this task changes. The callback will be called at least once, on registration, with the current value of the progress.

Specified by:

onProgress in interface ProgressingFuture<T>

Parameters:

reporter - the callback to call.

cancel

public boolean cancel(boolean b)

Specified by:

cancel in interface Future<T>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<T>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<T>

get

public T get()
      throws InterruptedException,
             ExecutionException

Specified by:

get in interface Future<T>

Throws:

InterruptedException

ExecutionException

get

public T get(long l,
             TimeUnit timeUnit)
      throws InterruptedException,
             ExecutionException,
             TimeoutException

Specified by:

get in interface Future<T>

Throws:

InterruptedException

ExecutionException

TimeoutException

addListener

public void addListener(Runnable listener,
                        Executor executor)

Specified by:

addListener in interface com.google.common.util.concurrent.ListenableFuture<T>