ArchipelagoFuture (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- edu.utexas.clm.archipelago.compute.ArchipelagoFuture<T>

All Implemented Interfaces:: Future<T>

public class ArchipelagoFuture<T>
extends Object
implements Future<T>

Constructor Summary

Constructors
Constructor and Description

ArchipelagoFuture(Scheduler scheduler)

ArchipelagoFuture(Scheduler s, T inData)

Constructors
Constructor and Description
`ArchipelagoFuture(Scheduler scheduler)`
`ArchipelagoFuture(Scheduler s, T inData)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`cancel(boolean b)` Cancels execution of this thread, optionally continuing execution if the associated Callable is already running.
`boolean`	`finish(ProcessManager<?> pm)`
`boolean`	`finish(Throwable exception)`
`T`	`get()`
`T`	`get(long l, TimeUnit timeUnit)`
`long`	`getID()`
`boolean`	`isCancelled()`
`boolean`	`isDone()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ArchipelagoFuture
```
public ArchipelagoFuture(Scheduler scheduler)
```
  - ArchipelagoFuture
```
public ArchipelagoFuture(Scheduler s,
                         T inData)
```
- Method Detail
  - getID
```
public long getID()
```
  - finish
```
public boolean finish(Throwable exception)
```
  - finish
```
public boolean finish(ProcessManager<?> pm)
               throws ClassCastException
```
    Throws:
    
    ClassCastException
  - cancel
```
public boolean cancel(boolean b)
```
    Cancels execution of this thread, optionally continuing execution if the associated Callable is already running. In the case that a running Callable is cancelled, any waiting get() methods will throw an InterruptedException
    
    Specified by:
    
    cancel in interface Future<T>
    
    Parameters:
    
    b - if true, the job associated with this Future will be cancelled even if it is currently executing, if false, this call to cancel() will be ignored.
    
    Returns:
    
    true if the job was cancelled, false otherwise.
  - 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

Class ArchipelagoFuture<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ArchipelagoFuture

ArchipelagoFuture

Method Detail

getID

finish

finish

cancel

isCancelled

isDone

get

get