gololang.concurrent.async

Class AssignedFuture

java.lang.Object

gololang.concurrent.async.AssignedFuture

All Implemented Interfaces:

Future

public final class AssignedFuture
extends java.lang.Object
implements Future

Convenience implementation for pre-set futures.

Nested Class Summary

Nested classes/interfaces inherited from interface gololang.concurrent.async.Future

Future.Observer

Method Summary

Modifier and Type	Method and Description
java.lang.Object	blockingGet() Blocking get, waiting until the future has been resolved.
static AssignedFuture	failedFuture(java.lang.Throwable throwable) Builds a new future that has failed.
java.lang.Object	get() Non-blocking get.
boolean	isFailed() Test whether the future has failed.
boolean	isResolved() Test whether the future has been resolved, that is, the future is either set or failed.
Future	onFail(Future.Observer observer) Registers a callback for when the future fails.
Future	onSet(Future.Observer observer) Registers a callback for when the future is set.
static AssignedFuture	setFuture(java.lang.Object value) Builds a new future that has been set to a value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

setFuture

public static AssignedFuture setFuture(java.lang.Object value)

Builds a new future that has been set to a value.

Parameters:

value - the future value.

Returns:

a new future object.

failedFuture

public static AssignedFuture failedFuture(java.lang.Throwable throwable)

Builds a new future that has failed.

Parameters:

throwable - the failure.

Returns:

a new future object.

get

public java.lang.Object get()

Description copied from interface: Future

Non-blocking get.

Specified by:

get in interface Future

Returns:

the future value, which may be null if it has not been resolved yet.

blockingGet

public java.lang.Object blockingGet()
                             throws java.lang.InterruptedException

Description copied from interface: Future

Blocking get, waiting until the future has been resolved.

Specified by:

blockingGet in interface Future

Returns:

the future value.

Throws:

java.lang.InterruptedException - when the current thread is being interrupted.

isResolved

public boolean isResolved()

Description copied from interface: Future

Test whether the future has been resolved, that is, the future is either set or failed.

Specified by:

isResolved in interface Future

Returns:

true if the future is resolved, false otherwise.

isFailed

public boolean isFailed()

Description copied from interface: Future

Test whether the future has failed.

Specified by:

isFailed in interface Future

Returns:

true if the future is resolved and failed, false otherwise.

onSet

public Future onSet(Future.Observer observer)

Description copied from interface: Future

Registers a callback for when the future is set. If the future has already been set, then it is executed immediately from the caller thread.

Specified by:

onSet in interface Future

Parameters:

observer - the callback.

Returns:

this future object.

onFail

public Future onFail(Future.Observer observer)

Description copied from interface: Future

Registers a callback for when the future fails. If the future has already been failed, then it is executed immediately from the caller thread.

Specified by:

onFail in interface Future

Parameters:

observer - the callback.

Returns:

this future object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object