com.peterphi.std.threading

Class SettableFuture<T>

java.lang.Object

com.peterphi.std.threading.SettableFuture<T>

Type Parameters:

T -

All Implemented Interfaces:

java.util.concurrent.Future<T>

Direct Known Subclasses:

RunnableCallableFuture

public class SettableFuture<T>
extends java.lang.Object
implements java.util.concurrent.Future<T>

A simple Future whose value will be set at some later date

Constructor Summary

Constructors

Constructor and Description
SettableFuture()
SettableFuture(ParamInvokeable<SettableFuture<T>> onSet, ParamInvokeable<SettableFuture<T>> onCancel) Create a SettableFuture which will potentially execute tasks upon set and upon cancel; the handlers will hold the exclusive lock on the monitor for the duration of their execution The handlers, (as they are ParamInvokeables) run synchronously with the call to set or cancel; they run after the effects have taken place and after any interested parties waiting on the monitor have been notified

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel() Cancels this Future
boolean	cancel(boolean mayInterruptIfRunning)
void	fail(java.lang.Throwable exception)
T	get()
T	get(Deadline deadline)
T	get(long quantity, java.util.concurrent.TimeUnit unit)
boolean	isCancelled()
boolean	isDone()
protected void	on_cancel()
protected void	on_set()
T	poll()
void	set(T value)

Methods inherited from class java.lang.Object

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

Constructor Detail

SettableFuture

public SettableFuture()

SettableFuture

public SettableFuture(ParamInvokeable<SettableFuture<T>> onSet,
              ParamInvokeable<SettableFuture<T>> onCancel)

Create a SettableFuture which will potentially execute tasks upon set and upon cancel; the handlers will hold the exclusive lock on the monitor for the duration of their execution
The handlers, (as they are ParamInvokeables) run synchronously with the call to set or cancel; they run after the effects have taken place and after any interested parties waiting on the monitor have been notified

Parameters:

onSet -

onCancel -

Method Detail

set

public void set(T value)

fail

public void fail(java.lang.Throwable exception)

on_set

protected void on_set()

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

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

cancel

public boolean cancel()

Cancels this Future

Returns:

on_cancel

protected void on_cancel()

get

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

Specified by:

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

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

poll

public final T poll()
             throws java.util.concurrent.ExecutionException

Throws:

java.util.concurrent.ExecutionException

get

public final T get(long quantity,
    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<T>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

get

public final T get(Deadline deadline)
            throws java.lang.InterruptedException,
                   java.util.concurrent.ExecutionException,
                   java.util.concurrent.TimeoutException

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<T>

isDone

public boolean isDone()

Specified by:

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