org.opendaylight.vtn.manager.internal.flow.reader

Class AbstractReadFlowFuture<T>

java.lang.Object

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

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

org.opendaylight.vtn.manager.internal.flow.reader.AbstractReadFlowFuture<T>

Type Parameters:

T - The type of the result of this future.

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:

FlowCountFuture, ReadFlowFuture

public abstract class AbstractReadFlowFuture<T>
extends SettableVTNFuture<T>

AbstractReadFlowFuture is a base class for future associated with the read operation which fetches data flow information.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractReadFlowFuture(TxContext ctx, String tname) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkTenant() Ensure that the target VTN is present.
protected String	getTenantName() Return the name of the target VTN.
protected TxContext	getTxContext() Return the context for the MD-SAL datastore transaction.
protected void	setFailure(Throwable cause) Set the cause of failure.
protected void	setResult(T result) Set the result of this future.

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

cancel, get, get, isCancelled, isDone, maskCancel, onFutureFailed, onFutureSucceeded, set, setException, setThread, unmaskCancel

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

AbstractReadFlowFuture

protected AbstractReadFlowFuture(TxContext ctx,
                                 String tname)
                          throws RpcException

Construct a new instance.

Parameters:

ctx - A TxContext instance.

tname - The name of the target VTN.

Throws:

RpcException - An error occurred.

Method Detail

getTxContext

protected final TxContext getTxContext()

Return the context for the MD-SAL datastore transaction.

Returns:

A TxContext instance.

getTenantName

protected final String getTenantName()

Return the name of the target VTN.

Returns:

The name of the target VTN.

checkTenant

protected final boolean checkTenant()

Ensure that the target VTN is present.

This method set an exception as the result of this future if false is returned.

Returns:

true if the target VTN is present. false otherwise.

setResult

protected final void setResult(T result)

Set the result of this future.

Parameters:

result - The result of this future.

setFailure

protected final void setFailure(Throwable cause)

Set the cause of failure.

Parameters:

cause - A Throwable that indicates the cause of failure.