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

Class VTNDlAddrAction

java.lang.Object

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

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

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

All Implemented Interfaces:

VTNIdentifiable<Integer>

Direct Known Subclasses:

VTNSetDlDstAction, VTNSetDlSrcAction

public abstract class VTNDlAddrAction
extends FlowFilterAction

VTNDlAddrAction describes the flow action that sets the MAC address into Ethernet header.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VTNDlAddrAction(EtherAddress addr) Construct a new instance without specifying action order.
protected	VTNDlAddrAction(EtherAddress addr, Integer ord) Construct a new instance with specifying action order.
protected	VTNDlAddrAction(VtnDladdrActionFields act, Integer ord) 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.
EtherAddress	getAddress() Return the MAC address to be set.
protected String	getDescription(String name, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress mac) Return a description about the specified MD-SAL action.
protected String	getDescription(String name, VtnDladdrActionFields act) Return a description about the specified VTN action.
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress	getMacAddress() Return the MAC address to be set as a MacAddress instance.
int	hashCode() Return the hash code of this object.
protected RpcException	noMacAddress(Object obj) Return an exception which indicates no MAC address is specified.
protected void	verifyImpl() Verify the contents of this instance.

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

apply, getDescription, getIdentifier, getOrder, toFlowFilterAction, toVtnFlowAction, verify

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

cast, getDescription, getErrorMessage, set, set, toActionBuilder, toString, toVtnAction, toVtnFlowActionBuilder

Methods inherited from class java.lang.Object

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

Constructor Detail

VTNDlAddrAction

protected VTNDlAddrAction(EtherAddress addr)

Construct a new instance without specifying action order.

Parameters:

addr - An EtherAddress instance which represents the MAC address to be set.

VTNDlAddrAction

protected VTNDlAddrAction(EtherAddress addr,
                          Integer ord)

Construct a new instance with specifying action order.

Parameters:

addr - An EtherAddress instance which represents the MAC address to be set.

ord - An integer which determines the order of flow actions in a flow entry.

VTNDlAddrAction

protected VTNDlAddrAction(VtnDladdrActionFields act,
                          Integer ord)
                   throws RpcException

Construct a new instance.

Parameters:

act - A VtnDladdrActionFields instance.

ord - An integer which determines the order of flow actions in a flow entry.

Throws:

RpcException - An invalid argument is specified.

Method Detail

getAddress

public final EtherAddress getAddress()

Return the MAC address to be set.

Returns:

The MAC address to be set.

getMacAddress

public final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getMacAddress()

Return the MAC address to be set as a MacAddress instance.

Returns:

A MacAddress instance.

noMacAddress

protected final RpcException noMacAddress(Object obj)

Return an exception which indicates no MAC address is specified.

Parameters:

obj - An object to be added to the error message.

Returns:

An RpcException instance.

getDescription

protected final String getDescription(String name,
                                      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress mac)

Return a description about the specified MD-SAL action.

Parameters:

name - The name of the flow action.

mac - A MacAddress instance.

Returns:

A description about the specified MD-SAL action.

getDescription

protected final String getDescription(String name,
                                      VtnDladdrActionFields act)

Return a description about the specified VTN action.

Parameters:

name - The name of the flow action.

act - A VtnDladdrActionFields instance.

Returns:

A description about the specified VTN action.

verifyImpl

protected final void verifyImpl()
                         throws RpcException

Verify the contents of this instance.

Specified by:

verifyImpl in class FlowFilterAction

Throws:

RpcException - Verification failed.

appendContents

protected final void appendContents(StringBuilder builder)

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

Overrides:

appendContents in class FlowFilterAction

Parameters:

builder - A StringBuilder instance.

equals

public final boolean equals(Object o)

Determine whether the given object is identical to this object.

Overrides:

equals in class FlowFilterAction

Parameters:

o - An object to be compared.

Returns:

true if identical. Otherwise false.

hashCode

public final int hashCode()

Return the hash code of this object.

Overrides:

hashCode in class FlowFilterAction

Returns:

The hash code.