org.opendaylight.vtn.manager.internal.vnode

Class GetVlanMapFuture

java.lang.Object

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

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

org.opendaylight.vtn.manager.internal.vnode.GetVlanMapFuture

All Implemented Interfaces:

com.google.common.util.concurrent.CheckedFuture<VlanMap,VTNException>, com.google.common.util.concurrent.FutureCallback<com.google.common.base.Optional<VlanMap>>, com.google.common.util.concurrent.ListenableFuture<VlanMap>, Future<VlanMap>, VTNFuture<VlanMap>, RpcOutputGenerator<VlanMap,GetVlanMapOutput>

public final class GetVlanMapFuture
extends SettableVTNFuture<VlanMap>
implements com.google.common.util.concurrent.FutureCallback<com.google.common.base.Optional<VlanMap>>, RpcOutputGenerator<VlanMap,GetVlanMapOutput>

GetVlanMapFuture describes a future associated with the task that implements get-vlan-map RPC.

Constructor Summary

Constructors

Constructor and Description
GetVlanMapFuture(TxContext ctx, GetVlanMapInput input) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
GetVlanMapOutput	createOutput(VlanMap result) Generate the output of the RPC request.
Class<GetVlanMapOutput>	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<VlanMap> result) Invoked when the read operation has completed successfully.

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

GetVlanMapFuture

public GetVlanMapFuture(TxContext ctx,
                        GetVlanMapInput input)
                 throws RpcException

Construct a new instance.

Parameters:

ctx - MD-SAL datastore transaction context.

input - A GetVlanMapInput instance.

Throws:

RpcException - The given input contains invalid value.

Method Detail

onSuccess

public void onSuccess(@Nonnull
                      com.google.common.base.Optional<VlanMap> 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<VlanMap>>

Parameters:

result - An Optional instance that contains the VLAN mapping.

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

Parameters:

cause - A Throwable that indicates the cause of failure.

getOutputType

public Class<GetVlanMapOutput> getOutputType()

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

Specified by:

getOutputType in interface RpcOutputGenerator<VlanMap,GetVlanMapOutput>

Returns:

A class which indicates the type of the RPC output.

createOutput

public GetVlanMapOutput createOutput(VlanMap result)

Generate the output of the RPC request.

Specified by:

createOutput in interface RpcOutputGenerator<VlanMap,GetVlanMapOutput>

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.