org.opendaylight.vtn.manager.internal.util.concurrent

Class SettableVTNFuture<T>

java.lang.Object

org.opendaylight.vtn.manager.internal.util.concurrent.AbstractVTNFuture<T>

org.opendaylight.vtn.manager.internal.util.concurrent.SettableVTNFuture<T>

Type Parameters:

T - The type of the object to be returned.

All Implemented Interfaces:

com.google.common.util.concurrent.CheckedFuture<T,VTNException>, com.google.common.util.concurrent.ListenableFuture<T>, Future<T>, VTNFuture<T>

Direct Known Subclasses:

AbstractReadFlowFuture, GetMacMappedHostFuture, GetVlanMapFuture, RpcFuture, RunnableVTNFuture

public class SettableVTNFuture<T>
extends AbstractVTNFuture<T>

An implementation of VTNFuture that requires the task result to be set externally.

Constructor Summary

Constructors

Constructor and Description
SettableVTNFuture()

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean intr) Attempt to cancel execution of the task.
T	get() Wait for the task to complete, and then return the result of the task.
T	get(long timeout, TimeUnit unit) Wait for the task to complete, and then return the result of the task.
boolean	isCancelled() Determine whether the task was canceled before it completed normally.
boolean	isDone() Determine whether the task completed or not.
protected boolean	maskCancel() Mask cancellation temporarily.
protected void	onFutureFailed(Throwable cause) Invoked when the computation has completed abnormally.
protected void	onFutureSucceeded(T result) Invoked when the computation has completed normally.
boolean	set(T result) Set the result of the task associated with the future.
boolean	setException(Throwable cause) Set a Throwable that indicates the cause of error.
boolean	setThread(Thread t) Set a thread that is executing the task.
protected boolean	unmaskCancel() Unmask cancellation masked by the previous call of maskCancel().

Methods inherited from class org.opendaylight.vtn.manager.internal.util.concurrent.AbstractVTNFuture

addListener, done, getCause, getException

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.vtn.manager.internal.util.concurrent.VTNFuture

checkedGet, checkedGet

Constructor Detail

SettableVTNFuture

public SettableVTNFuture()

Method Detail

setThread

public final boolean setThread(Thread t)

Set a thread that is executing the task.

Parameters:

t - A Thread instance.

Returns:

true only if the task has already been canceled.

set

public final boolean set(T result)

Set the result of the task associated with the future.

Subclass needs to call this method when the computation is complete.

Parameters:

result - A value returned by the task.

Returns:

true if the future state has been changed. false if the task already completed.

setException

public final boolean setException(Throwable cause)

Set a Throwable that indicates the cause of error.

Subclass needs to call this method when the task has caught an unhandled exception.

Parameters:

cause - A Throwable instance.

Returns:

true if the future state has been changed. false if the task already completed.

maskCancel

protected final boolean maskCancel()
                            throws InterruptedException

Mask cancellation temporarily.

This method is expected to be called on the thread that is executing the task. This method has no effect if the task is already completed successfully.

Returns:

true on success. false if the task has already completed.

Throws:

InterruptedException - The task has already been canceled.

unmaskCancel

protected final boolean unmaskCancel()
                              throws InterruptedException

Unmask cancellation masked by the previous call of maskCancel().

This method is expected to be called on the thread that is executing the task. This method has no effect if the task is already completed successfully.

Returns:

true on success. false if the task has already completed.

Throws:

InterruptedException - The task has already been canceled.

onFutureSucceeded

protected void onFutureSucceeded(T result)

Invoked when the computation has completed normally.

Note that this method is called prior to FutureCallback.

Parameters:

result - The result of the task.

onFutureFailed

protected void onFutureFailed(Throwable cause)

Invoked when the computation has completed abnormally.

Note that this method is called prior to FutureCallback.

Parameters:

cause - A Throwable that indicates the cause of failure.

cancel

public boolean cancel(boolean intr)

Attempt to cancel execution of the task.

Parameters:

intr - true if the task runner thread should be interrupted. Otherwise in-progress task are allowed to complete.

Returns:

true only if the task was canceled.

isCancelled

public boolean isCancelled()

Determine whether the task was canceled before it completed normally.

Returns:

true only if the task was canceled.

isDone

public boolean isDone()

Determine whether the task completed or not.

Returns:

true only if the task completed.

get

public T get()
      throws InterruptedException,
             ExecutionException

Wait for the task to complete, and then return the result of the task.

Returns:

The result of the task.

Throws:

CancellationException - The task was canceled.

InterruptedException - The current thread was interrupted while waiting.

ExecutionException - The task caught an exception.

get

public T get(long timeout,
             TimeUnit unit)
      throws InterruptedException,
             ExecutionException,
             TimeoutException

Wait for the task to complete, and then return the result of the task.

Parameters:

timeout - The maximum time to wait

unit - The time unit of timeout.

Returns:

The result of the task.

Throws:

CancellationException - The task was canceled.

InterruptedException - The current thread was interrupted while waiting.

ExecutionException - The task caught an exception.

TimeoutException - The task did not complete within the given timeout.