com.scaleoutsoftware.soss.client.util

Class FutureImpl<V>

java.lang.Object

com.scaleoutsoftware.soss.client.util.FutureImpl<V>

Type Parameters:

V - the result type of the object returned when the operation completes.

All Implemented Interfaces:

com.scaleoutsoftware.soss.client.da.ListenableFuture<V>, java.util.concurrent.Future<V>

public class FutureImpl<V>
extends java.lang.Object
implements com.scaleoutsoftware.soss.client.da.ListenableFuture<V>

A base implementation of the Future interface.

Constructor Summary

Constructors

Constructor and Description
FutureImpl()

Method Summary

Modifier and Type	Method and Description
void	addListener(com.scaleoutsoftware.soss.client.da.FutureListener<V> listener)
boolean	cancel(boolean mayInterruptIfRunning)
V	get()
V	get(long timeout, java.util.concurrent.TimeUnit unit)
boolean	isCancelled()
boolean	isDone()
void	removeListener(com.scaleoutsoftware.soss.client.da.FutureListener<V> listener)
void	setComplete(V value) Indicate that the operation has successfully completed.
boolean	setCompleteIfActive(V value) If the operation has not yet finished, indicate that the operation has successfully completed.
void	setException(java.lang.Throwable cause) Indicate that the operation was unsuccessfully completed.
boolean	setExceptionIfActive(java.lang.Throwable cause) If the operation has not yet finished, indicate that the operation has failed.
void	setThread(java.lang.Thread threadExecutingOperation) Record the Thread executing the operation so that we know which thread to interrupt if the cancel(boolean) method is called.
boolean	setThreadIfActive(java.lang.Thread threadExecutingOperation) If the operation is not yet finished, record the Thread executing the operation so that we know which thread to interrupt if the cancel(boolean) method is called.

Methods inherited from class java.lang.Object

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

Constructor Detail

FutureImpl

public FutureImpl()

Method Detail

setThread

public void setThread(java.lang.Thread threadExecutingOperation)

Record the Thread executing the operation so that we know which thread to interrupt if the cancel(boolean) method is called. If not set, no thread will be interrupted if the operation is cancelled and the operation will continue even after waiters are released.

Callers should verify the operation hasn't been cancelled prior to calling this method.

Parameters:

threadExecutingOperation - the thread that is executing the requested operation: the thread that will be interrupted if a cancel(boolean) is requested.

Throws:

java.lang.IllegalStateException - if the operation is no longer pending.

See Also:

setThreadIfActive(Thread)

setThreadIfActive

public boolean setThreadIfActive(java.lang.Thread threadExecutingOperation)

If the operation is not yet finished, record the Thread executing the operation so that we know which thread to interrupt if the cancel(boolean) method is called. If not set, no thread will be interrupted if the operation is cancelled and the operation will continue even after waiters are released.

if the operation is finished, this method is a nop.

Parameters:

threadExecutingOperation - the thread that is executing the requested operation: the thread that will be interrupted if a cancel(boolean) is requested.

Returns:

true if this invocation successfully set the thread. false if the operation was already complete.

See Also:

setThread(Thread)

setComplete

public void setComplete(V value)

Indicate that the operation has successfully completed. Set this Future's return value and release any threads waiting for the operation to complete.

Parameters:

value - the result to be returned via get().

See Also:

setCompleteIfActive(Object)

setCompleteIfActive

public boolean setCompleteIfActive(V value)

If the operation has not yet finished, indicate that the operation has successfully completed. Set this Future's return value and release any threads waiting for the operation to complete.

If the operation has finished, this method is a nop.

Parameters:

value - the result to be returned via get().

Returns:

true if this invocation caused the future to become "done". false otherwise.

See Also:

setComplete(Object)

setException

public void setException(java.lang.Throwable cause)

Indicate that the operation was unsuccessfully completed. Establish cause as the reason for the operation's failure. When get() is called, an instance of ExecutionException with a cause set to cause will be thrown.

Parameters:

cause - the cause of the operation's failure.

Throws:

java.lang.IllegalStateException - if the operation was already complete.

See Also:

setExceptionIfActive(Throwable)

setExceptionIfActive

public boolean setExceptionIfActive(java.lang.Throwable cause)

If the operation has not yet finished, indicate that the operation has failed. Establish cause as the reason for the operation's failure. When get() is called, an instance of ExecutionException with a cause set to cause will be thrown.

If the operation has finished, this method is a nop.

Parameters:

cause - the cause of the operation's failure.

Returns:

true if this invocation caused the future to become "done". false otherwise.

See Also:

setException(Throwable)

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.CancellationException,
             java.util.concurrent.ExecutionException

Specified by:

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

Throws:

java.lang.InterruptedException

java.util.concurrent.CancellationException

java.util.concurrent.ExecutionException

get

public V get(long timeout,
             java.util.concurrent.TimeUnit unit)
      throws java.lang.InterruptedException,
             java.util.concurrent.CancellationException,
             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.CancellationException

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>

addListener

public void addListener(com.scaleoutsoftware.soss.client.da.FutureListener<V> listener)

Specified by:

addListener in interface com.scaleoutsoftware.soss.client.da.ListenableFuture<V>

removeListener

public void removeListener(com.scaleoutsoftware.soss.client.da.FutureListener<V> listener)

Specified by:

removeListener in interface com.scaleoutsoftware.soss.client.da.ListenableFuture<V>