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

Class VTNFlowCondition

java.lang.Object

org.opendaylight.vtn.manager.internal.util.flow.cond.VTNFlowCondition

All Implemented Interfaces:

VTNIdentifiable<String>

public final class VTNFlowCondition
extends Object
implements VTNIdentifiable<String>

VTNFlowCondition describes configuration for a flow condition.

Constructor Summary

Constructors

Constructor and Description
VTNFlowCondition(VtnFlowCondConfig vfconf) Construct a new instance from the given VtnFlowCondConfig instance.

Method Summary

Modifier and Type	Method and Description
static VTNFlowCondition	create(VtnFlowCondition vfc) Convert the given VtnFlowCondition instance into a VTNFlowCondition instance.
boolean	equals(Object o) Determine whether the given object is identical to this object.
String	getIdentifier() Return the identifier of this instance.
org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowCondition>	getPath() Return the path to this flow condition.
int	hashCode() Return the hash code of this object.
boolean	match(FlowMatchContext ctx) Determine whether this flow condition matches the given packet header or not.
SetFlowConditionInputBuilder	toSetFlowConditionInputBuilder() Return a SetFlowConditionInputBuilder instance which contains the configuration configured in this instance.
VtnFlowConditionBuilder	toVtnFlowConditionBuilder() Return a VtnFlowConditionBuilder instance which contains the configuration configured in this instance.
void	verify() Verify the contents of this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

VTNFlowCondition

public VTNFlowCondition(VtnFlowCondConfig vfconf)
                 throws RpcException

Construct a new instance from the given VtnFlowCondConfig instance.

Parameters:

vfconf - A VtnFlowCondConfig instance.

Throws:

RpcException - An error occurred.

Method Detail

create

public static VTNFlowCondition create(VtnFlowCondition vfc)

Convert the given VtnFlowCondition instance into a VTNFlowCondition instance.

Parameters:

vfc - A VtnFlowCondition instance to be converted.

Returns:

A VTNFlowCondition instance on success. null on failure.

toVtnFlowConditionBuilder

public VtnFlowConditionBuilder toVtnFlowConditionBuilder()

Return a VtnFlowConditionBuilder instance which contains the configuration configured in this instance.

Returns:

A VtnFlowConditionBuilder instance.

toSetFlowConditionInputBuilder

public SetFlowConditionInputBuilder toSetFlowConditionInputBuilder()

Return a SetFlowConditionInputBuilder instance which contains the configuration configured in this instance.

Returns:

A SetFlowConditionInputBuilder instance.

getPath

public org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnFlowCondition> getPath()

Return the path to this flow condition.

Returns:

An InstanceIdentifier instance that represents the path to this flow condition.

verify

public void verify()
            throws RpcException

Verify the contents of this instance.

Throws:

RpcException - Verification failed.

match

public boolean match(FlowMatchContext ctx)

Determine whether this flow condition matches the given packet header or not.

Parameters:

ctx - A FlowMatchContext instance.

Returns:

true if this flow condition matches the packet header specified by ctx. Otherwise false.

getIdentifier

public String getIdentifier()

Return the identifier of this instance.

Specified by:

getIdentifier in interface VTNIdentifiable<String>

Returns:

The name of the flow condition.

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.