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

Class VTNInetAddrAction

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.VTNInetAddrAction

All Implemented Interfaces:

VTNIdentifiable<Integer>

Direct Known Subclasses:

VTNSetInetDstAction, VTNSetInetSrcAction

public abstract class VTNInetAddrAction
extends FlowFilterAction

VTNInetAddrAction describes the flow action that sets the IP address into IP header.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VTNInetAddrAction(IpNetwork addr) Construct a new instance without specifying action order.
protected	VTNInetAddrAction(IpNetwork addr, Integer ord) Construct a new instance with specifying action order.
protected	VTNInetAddrAction(VtnIpaddrActionFields 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.
IpNetwork	getAddress() Return the IP address to be set.
protected String	getDescription(String name, org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.address.Address addr) Return a description about the specified MD-SAL action.
protected String	getDescription(String name, VtnIpaddrActionFields act) Return a description about the specified VTN action.
org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.address.Address	getMdAddress() Return the IP address to be set as an Address instance.
int	hashCode() Return the hash code of this object.
protected RpcException	noIpAddress(Object obj) Return an exception which indicates no IP 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

VTNInetAddrAction

protected VTNInetAddrAction(IpNetwork addr)

Construct a new instance without specifying action order.

Parameters:

addr - An IpNetwork instance which represents the IP address to be set.

VTNInetAddrAction

protected VTNInetAddrAction(IpNetwork addr,
                            Integer ord)

Construct a new instance with specifying action order.

Parameters:

addr - An IpNetwork instance which represents the IP address to be set.

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

VTNInetAddrAction

protected VTNInetAddrAction(VtnIpaddrActionFields act,
                            Integer ord)
                     throws RpcException

Construct a new instance.

Parameters:

act - A VtnIpaddrActionFields 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 IpNetwork getAddress()

Return the IP address to be set.

Returns:

The IP address to be set.

getMdAddress

public final org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.address.Address getMdAddress()

Return the IP address to be set as an Address instance.

Returns:

An Address instance.

noIpAddress

protected final RpcException noIpAddress(Object obj)

Return an exception which indicates no IP 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.opendaylight.action.types.rev131112.address.Address addr)

Return a description about the specified MD-SAL action.

Parameters:

name - The name of the flow action.

addr - An Address instance.

Returns:

A description about the specified MD-SAL action.

getDescription

protected final String getDescription(String name,
                                      VtnIpaddrActionFields act)

Return a description about the specified VTN action.

Parameters:

name - The name of the flow action.

act - A VtnIpaddrActionFields 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.