er.extensions.concurrency

Class ERXFutureTask<V>

java.lang.Object

java.util.concurrent.FutureTask<V>

er.extensions.concurrency.ERXFutureTask<V>

Type Parameters:

V - the result type returned by this ERXFutureTask's get method

All Implemented Interfaces:

NSKeyValueCoding, IERXExecutionStateTransition, IERXPercentComplete, IERXStatus, Runnable, Future<V>, RunnableFuture<V>

public class ERXFutureTask<V>
extends FutureTask<V>
implements IERXExecutionStateTransition, IERXStatus, IERXPercentComplete, NSKeyValueCoding

A FutureTask that implements IERXStatus, IERXPercentComplete and NSKeyValueCoding. Additional methods are provided in this FutureTask for checking if those interfaces are implemented in the wrapped task and if so the values are passed thru from the task. Usage:

   // If null, then submit the callable task
   ERXFutureTask _future = new ERXFutureTask(callable);
   ERXExecutorService.executorService().execute(_future);
   

Author:

kieran

Nested Class Summary

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding._BooleanFieldBinding, NSKeyValueCoding._BooleanMethodBinding, NSKeyValueCoding._FieldBinding, NSKeyValueCoding._ForwardingBinding, NSKeyValueCoding._KeyBinding, NSKeyValueCoding._KeyBindingCreation, NSKeyValueCoding._MethodBinding, NSKeyValueCoding._NumberFieldBinding, NSKeyValueCoding._NumberMethodBinding, NSKeyValueCoding._ReflectionKeyBindingCreation, NSKeyValueCoding.DefaultImplementation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null<T>, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.Utility, NSKeyValueCoding.ValueAccessor

Field Summary

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

_CLASS, NullValue

Constructor Summary

Constructors

Constructor and Description
ERXFutureTask(Callable<V> callable)
ERXFutureTask(Runnable runnable, V result)

Method Summary

Modifier and Type	Method and Description
void	afterExecute() Method invoked upon completion of execution of the given Runnable/Callable.
void	beforeExecute() Method invoked prior to executing the given Runnable/Callable.
boolean	hasPercentComplete()
boolean	hasStatus()
boolean	isStoppable()
Double	percentComplete()
String	status()
void	takeValueForKey(Object value, String key)
Object	task()
String	toString()
Object	valueForKey(String key)

Methods inherited from class java.util.concurrent.FutureTask

cancel, done, get, get, isCancelled, isDone, run, runAndReset, set, setException

Methods inherited from class java.lang.Object

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

Constructor Detail

ERXFutureTask

public ERXFutureTask(Callable<V> callable)

ERXFutureTask

public ERXFutureTask(Runnable runnable,
                     V result)

Method Detail

task

public Object task()

status

public String status()

Specified by:

status in interface IERXStatus

Returns:

the status of a task. Useful for a long running task to implement an optional status message.

percentComplete

public Double percentComplete()

Specified by:

percentComplete in interface IERXPercentComplete

Returns:

a Double between 0 and 1.0 indicating how far a task has progressed toward completion. A null return value indicates that percent complete is unknown

takeValueForKey

public void takeValueForKey(Object value,
                            String key)

Specified by:

takeValueForKey in interface NSKeyValueCoding

valueForKey

public Object valueForKey(String key)

Specified by:

valueForKey in interface NSKeyValueCoding

hasStatus

public boolean hasStatus()

Returns:

whether the wrapped task implements the IERXStatus interface

isStoppable

public boolean isStoppable()

Returns:

whether the wrapped task implements the IERXStoppable interface

hasPercentComplete

public boolean hasPercentComplete()

Returns:

whether the wrapped task implements the IERXPercentComplete interface

afterExecute

public void afterExecute()

Description copied from interface: IERXExecutionStateTransition

Method invoked upon completion of execution of the given Runnable/Callable.

Specified by:

afterExecute in interface IERXExecutionStateTransition

beforeExecute

public void beforeExecute()

Description copied from interface: IERXExecutionStateTransition

Method invoked prior to executing the given Runnable/Callable.

Specified by:

beforeExecute in interface IERXExecutionStateTransition

toString

public String toString()

Overrides:

toString in class Object