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

Class FlowCountFuture

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

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

All Implemented Interfaces:

com.google.common.util.concurrent.CheckedFuture<Integer,VTNException>, com.google.common.util.concurrent.FutureCallback<com.google.common.base.Optional<VtnFlowTable>>, com.google.common.util.concurrent.ListenableFuture<Integer>, Future<Integer>, VTNFuture<Integer>, RpcOutputGenerator<Integer,GetDataFlowCountOutput>

public final class FlowCountFuture
extends AbstractReadFlowFuture<Integer>
implements com.google.common.util.concurrent.FutureCallback<com.google.common.base.Optional<VtnFlowTable>>, RpcOutputGenerator<Integer,GetDataFlowCountOutput>

FlowCountFuture describes a future associated with the task which retrieves the number of data flows present in the specified VTN.

Method Summary

Modifier and Type	Method and Description
static FlowCountFuture	create(TxContext ctx, GetDataFlowCountInput input) Construct a new instance.
GetDataFlowCountOutput	createOutput(Integer result) Generate the output of the RPC request.
Class<GetDataFlowCountOutput>	getOutputType() Return a class which indicates the type of the RPC output.
void	onFailure(Throwable cause) Invoked when the read operation has failed.
void	onSuccess(com.google.common.base.Optional<VtnFlowTable> result) Invoked when the read operation has completed successfully.

Methods inherited from class org.opendaylight.vtn.manager.internal.flow.reader.AbstractReadFlowFuture

checkTenant, getTenantName, getTxContext, setFailure, setResult

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

Method Detail

create

public static FlowCountFuture create(TxContext ctx,
                                     GetDataFlowCountInput input)
                              throws RpcException

Construct a new instance.

Parameters:

ctx - A TxContext instance.

input - Input of the RPC call.

Returns:

A FlowCountFuture instance.

Throws:

RpcException - An error occurred.

onSuccess

public void onSuccess(@Nonnull
                      com.google.common.base.Optional<VtnFlowTable> result)

Invoked when the read operation has completed successfully.

Specified by:

onSuccess in interface com.google.common.util.concurrent.FutureCallback<com.google.common.base.Optional<VtnFlowTable>>

Parameters:

result - An Optional instance that contains the VTN flow table.

onFailure

public void onFailure(Throwable cause)

Invoked when the read operation has failed.

Specified by:

onFailure in interface com.google.common.util.concurrent.FutureCallback<com.google.common.base.Optional<VtnFlowTable>>

Parameters:

cause - A Throwable that indicates the cause of failure.

getOutputType

public Class<GetDataFlowCountOutput> getOutputType()

Return a class which indicates the type of the RPC output.

Specified by:

getOutputType in interface RpcOutputGenerator<Integer,GetDataFlowCountOutput>

Returns:

A class which indicates the type of the RPC output.

createOutput

public GetDataFlowCountOutput createOutput(Integer result)

Generate the output of the RPC request.

Specified by:

createOutput in interface RpcOutputGenerator<Integer,GetDataFlowCountOutput>

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.