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

Class VTNPortAction

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

All Implemented Interfaces:

VTNIdentifiable<Integer>

Direct Known Subclasses:

VTNSetPortDstAction, VTNSetPortSrcAction

public abstract class VTNPortAction
extends FlowFilterAction

VTNPortAction describes the flow action that sets the port number for IP transport layer protocol into packet.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VTNPortAction(int p) Construct a new instance without specifying action order.
protected	VTNPortAction(int p, Integer ord) Construct a new instance with specifying action order.
protected	VTNPortAction(VtnPortActionFields 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.
protected String	getDescription(String name, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber port) Return a description about the specified MD-SAL action.
protected String	getDescription(String name, VtnPortActionFields act) Return a description about the specified VTN action.
int	getPort() Return the port number to be set.
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber	getPortNumber() Return the port number to be set as a PortNumber instance.
protected int	getPortNumber(VtnPortActionFields vport) Return the port number configured in the given VtnPortActionFields instance.
int	hashCode() Return the hash code of this object.
protected RpcException	noPortNumber(Object obj) Return an exception which indicates no port number 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

VTNPortAction

protected VTNPortAction(int p)

Construct a new instance without specifying action order.

Parameters:

p - The port numbet to be set.

VTNPortAction

protected VTNPortAction(int p,
                        Integer ord)

Construct a new instance with specifying action order.

Parameters:

p - The port numbet to be set.

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

VTNPortAction

protected VTNPortAction(VtnPortActionFields act,
                        Integer ord)
                 throws RpcException

Construct a new instance.

Parameters:

act - A VtnPortActionFields instance.

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

Throws:

RpcException - An invalid argument is specified.

Method Detail

getPort

public final int getPort()

Return the port number to be set.

Returns:

The port number to be set.

getPortNumber

public final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getPortNumber()

Return the port number to be set as a PortNumber instance.

Returns:

A PortNumber instance.

getPortNumber

protected final int getPortNumber(VtnPortActionFields vport)

Return the port number configured in the given VtnPortActionFields instance.

Parameters:

vport - A VtnPortActionFields instance.

Returns:

The port number.

noPortNumber

protected final RpcException noPortNumber(Object obj)

Return an exception which indicates no port number 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.inet.types.rev130715.PortNumber port)

Return a description about the specified MD-SAL action.

Parameters:

name - The name of the flow action.

port - A PortNumber instance.

Returns:

A description about the specified MD-SAL action.

getDescription

protected final String getDescription(String name,
                                      VtnPortActionFields act)

Return a description about the specified VTN action.

Parameters:

name - The name of the flow action.

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