org.opendaylight.vtn.manager.internal.util.flow.action

Class VTNPushVlanAction

java.lang.Object

org.opendaylight.vtn.manager.internal.util.flow.action.VTNFlowAction

org.opendaylight.vtn.manager.internal.util.flow.action.VTNPushVlanAction

public final class VTNPushVlanAction
extends VTNFlowAction

VTNPushVlanAction describes the flow action that adds a VLAN tag into packet.

Constructor Summary

Constructors

Constructor and Description
VTNPushVlanAction() Construct a new instance that adds an IEEE 802.1q VLAN tag.
VTNPushVlanAction(VlanType type) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	appendContents(StringBuilder builder) Append strings which represents the contents of this instance into the given StringBuilder instance.
boolean	equals(Object o) Determine whether the given object is identical to this object.
String	getDescription(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action act) Return a brief description about the specified MD-SAL action.
VlanType	getVlanType() Return the VLAN type for a new VLAN tag.
int	hashCode() Return the hash code of this object.
static VtnPushVlanActionCase	newVtnAction(VlanType vtype) Create a new VtnPushVlanActionCase instance.
protected org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder	set(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder builder) Set a MD-SAL action into the given action builder.
protected VtnFlowActionBuilder	set(VtnFlowActionBuilder builder) Set a VTN action into the given VTN flow action builder.
VtnPushVlanActionCase	toVtnAction(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action act) Convert the given MD-SAL action instance into a VtnAction instance.

Methods inherited from class org.opendaylight.vtn.manager.internal.util.flow.action.VTNFlowAction

cast, getErrorMessage, toActionBuilder, toString, toVtnFlowActionBuilder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VTNPushVlanAction

public VTNPushVlanAction()

Construct a new instance that adds an IEEE 802.1q VLAN tag.

VTNPushVlanAction

public VTNPushVlanAction(VlanType type)

Construct a new instance.

Parameters:

type - A VlanType instance which specifies the VLAN type.

Method Detail

newVtnAction

public static VtnPushVlanActionCase newVtnAction(VlanType vtype)

Create a new VtnPushVlanActionCase instance.

Parameters:

vtype - A VlanType instance which specifies the type of the VLAN tag.

Returns:

A VtnPushVlanActionCase instance.

getVlanType

public VlanType getVlanType()

Return the VLAN type for a new VLAN tag.

Returns:

A VlanType instance.

toVtnAction

public VtnPushVlanActionCase toVtnAction(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action act)
                                  throws RpcException

Convert the given MD-SAL action instance into a VtnAction instance.

Note that this method must not affect instance variables.

Specified by:

toVtnAction in class VTNFlowAction

Parameters:

act - An Action instance.

Returns:

A VtnAction instance.

Throws:

RpcException - Failed to convert the given instance.

getDescription

public String getDescription(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action act)
                      throws RpcException

Return a brief description about the specified MD-SAL action.

Note that this method must not affect instance variables.

Specified by:

getDescription in class VTNFlowAction

Parameters:

act - An Action instance.

Returns:

A brief description about the given MD-SAL action.

Throws:

RpcException - An error occurred.

set

protected VtnFlowActionBuilder set(VtnFlowActionBuilder builder)

Set a VTN action into the given VTN flow action builder.

Specified by:

set in class VTNFlowAction

Parameters:

builder - A VtnFlowActionBuilder instance.

Returns:

builder.

set

protected org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder set(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder builder)

Set a MD-SAL action into the given action builder.

Specified by:

set in class VTNFlowAction

Parameters:

builder - An ActionBuilder instance.

Returns:

builder.

appendContents

protected void appendContents(StringBuilder builder)

Append strings which represents the contents of this instance into the given StringBuilder instance.

Overrides:

appendContents in class VTNFlowAction

Parameters:

builder - A StringBuilder instance.

equals

public boolean equals(Object o)

Determine whether the given object is identical to this object.

Overrides:

equals in class VTNFlowAction

Parameters:

o - An object to be compared.

Returns:

true if identical. Otherwise false.

hashCode

public int hashCode()

Return the hash code of this object.

Overrides:

hashCode in class VTNFlowAction

Returns:

The hash code.