edu.wisc.ssec.mcidasv.util

Class BackgroundTask<V>

java.lang.Object

edu.wisc.ssec.mcidasv.util.BackgroundTask<V>

All Implemented Interfaces:

java.lang.Runnable, java.util.concurrent.Future<V>

Direct Known Subclasses:

Submitter

public abstract class BackgroundTask<V>
extends java.lang.Object
implements java.lang.Runnable, java.util.concurrent.Future<V>

Background task class supporting cancellation, completion notification, and progress notification. Courtesy of Java Concurrency in Practice, written by Brian Goetz and Tim Peierls.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	BackgroundTask.Computation

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.concurrent.FutureTask<V>	computation

Constructor Summary

Constructors

Constructor and Description
BackgroundTask()

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning)
protected abstract V	compute()
V	get()
V	get(long timeout, java.util.concurrent.TimeUnit unit)
boolean	isCancelled()
boolean	isDone()
protected void	onCompletion(V result, java.lang.Throwable exception, boolean cancelled)
protected void	onProgress(int current, int max)
void	run()
protected void	setProgress(int current, int max)

Methods inherited from class java.lang.Object

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

Field Detail

computation

private final java.util.concurrent.FutureTask<V> computation

Constructor Detail

BackgroundTask

public BackgroundTask()

Method Detail

setProgress

protected void setProgress(int current,
                           int max)

compute

protected abstract V compute()
                      throws java.lang.Exception

Throws:

java.lang.Exception

onCompletion

protected void onCompletion(V result,
                            java.lang.Throwable exception,
                            boolean cancelled)

onProgress

protected void onProgress(int current,
                          int max)

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface java.util.concurrent.Future<V>

get

public V get()
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException

Specified by:

get in interface java.util.concurrent.Future<V>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

get

public V get(long timeout,
             java.util.concurrent.TimeUnit unit)
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException,
             java.util.concurrent.TimeoutException

Specified by:

get in interface java.util.concurrent.Future<V>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface java.util.concurrent.Future<V>

isDone

public boolean isDone()

Specified by:

isDone in interface java.util.concurrent.Future<V>

run

public void run()

Specified by:

run in interface java.lang.Runnable