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

Class VTNFlowAction

java.lang.Object

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

Direct Known Subclasses:

FlowFilterAction, VTNDropAction, VTNOutputAction, VTNPopVlanAction, VTNPushVlanAction, VTNSetVlanIdAction

public abstract class VTNFlowAction
extends Object

VTNFlowAction descrbes the abstracted flow action.

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.
protected <T> T	cast(Class<T> type, Object obj) Cast the given object as the given type.
boolean	equals(Object o) Determine whether the given object is identical to this object.
abstract 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.
protected String	getErrorMessage(Object... args) Return a message which indicates an error caused by this class.
int	hashCode() Return the hash code of this object.
protected abstract 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 abstract VtnFlowActionBuilder	set(VtnFlowActionBuilder builder) Set a VTN action into the given VTN flow action builder.
org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder	toActionBuilder(Integer ord) Convert this instance into a MD-SAL action builder instance.
String	toString() Return a string representation of this instance.
abstract VtnAction	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.
VtnFlowActionBuilder	toVtnFlowActionBuilder(Integer ord) Convert this instance into a VTN flow action builder instance.

Methods inherited from class java.lang.Object

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

Method Detail

toVtnFlowActionBuilder

public final VtnFlowActionBuilder toVtnFlowActionBuilder(Integer ord)

Convert this instance into a VTN flow action builder instance.

Parameters:

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

Returns:

A VtnFlowActionBuilder instance.

toActionBuilder

public final org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder toActionBuilder(Integer ord)

Convert this instance into a MD-SAL action builder instance.

Parameters:

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

Returns:

An ActionBuilder instance.

getErrorMessage

protected final String getErrorMessage(Object... args)

Return a message which indicates an error caused by this class.

Parameters:

args - Objects to be embedded in an error message.

Returns:

An error message.

appendContents

protected void appendContents(StringBuilder builder)

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

Parameters:

builder - A StringBuilder instance.

cast

protected final <T> T cast(Class<T> type,
                           Object obj)
                    throws RpcException

Cast the given object as the given type.

Type Parameters:

T - The target type.

Parameters:

type - A class that indicates the target type.

obj - An object to be converted.

Returns:

obj casted as the given type.

Throws:

RpcException - Unable to cast the given instance.

toVtnAction

public abstract VtnAction 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.

Parameters:

act - An Action instance.

Returns:

A VtnAction instance.

Throws:

RpcException - Failed to convert the given instance.

getDescription

public abstract 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.

Parameters:

act - An Action instance.

Returns:

A brief description about the given MD-SAL action.

Throws:

RpcException - An error occurred.

set

protected abstract VtnFlowActionBuilder set(VtnFlowActionBuilder builder)

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

Parameters:

builder - A VtnFlowActionBuilder instance.

Returns:

builder.

set

protected abstract 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.

Parameters:

builder - An ActionBuilder instance.

Returns:

builder.

equals

public boolean equals(Object o)

Determine whether the given object is identical to this object.

Overrides:

equals in class Object

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 Object

Returns:

The hash code.

toString

public final String toString()

Return a string representation of this instance.

Overrides:

toString in class Object

Returns:

A string representation of this instance.