org.opendaylight.vtn.manager.internal.util.vnode

Class VTNVlanMapConfig

java.lang.Object

org.opendaylight.vtn.manager.internal.util.vnode.VTNVlanMapConfig

public final class VTNVlanMapConfig
extends Object

VTNVlanMapConfig describes configuration information about a VLAN mapping configured in a vBridge.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NODE_ID_ANY A pseudo node-id that indicates no physical switch is specified.

Constructor Summary

Constructors

Constructor and Description
VTNVlanMapConfig(VtnVlanMapConfig vvmc) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
static String	createMapId(SalNode snode, org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId vid) Construct an identifier for a VLAN mapping.
static String	createMapId(VtnVlanMapConfig cfg) Construct an identifier for a VLAN mapping.
boolean	equals(Object o) Determine whether the given object is identical to this object.
String	getMapId() Return an identifier for this VLAN mapping.
NodeVlan	getNodeVlan() Return a NodeVlan instance which specifies the target VLAN.
SalNode	getTargetNode() Return the target switch identifier.
int	getVlanId() Return the VLAN ID to be mapped.
int	hashCode() Return the hash code of this object.
VlanMapConfig	toVlanMapConfig() Convert this instance into a VlanMapConfig 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

Field Detail

NODE_ID_ANY

public static final String NODE_ID_ANY

A pseudo node-id that indicates no physical switch is specified.

See Also:

Constant Field Values

Constructor Detail

VTNVlanMapConfig

public VTNVlanMapConfig(VtnVlanMapConfig vvmc)
                 throws RpcException

Construct a new instance.

Parameters:

vvmc - A VtnVlanMapConfig instance.

Throws:

RpcException - vvmc contains invalid configuration.

Method Detail

createMapId

public static String createMapId(SalNode snode,
                                 org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId vid)

Construct an identifier for a VLAN mapping.

Parameters:

snode - A SalNode instance which specifies the physical switch. null indicates no switch is speciifed.

vid - A VlanId instance which indicates the VLAN ID. Specifying null results in undefined behavior.

Returns:

A VLAN mapping identifier.

createMapId

public static String createMapId(VtnVlanMapConfig cfg)

Construct an identifier for a VLAN mapping.

Parameters:

cfg - A VtnVlanMapConfig instance.

Returns:

A VLAN mapping identifier if the given configuration is valid. null otherwise.

getTargetNode

public SalNode getTargetNode()

Return the target switch identifier.

Returns:

A SalNode instance if the target switch is configured. null if not configured.

getVlanId

public int getVlanId()

Return the VLAN ID to be mapped.

Returns:

A VLAN ID.

getNodeVlan

public NodeVlan getNodeVlan()

Return a NodeVlan instance which specifies the target VLAN.

Returns:

A NodeVlan instance.

getMapId

public String getMapId()

Return an identifier for this VLAN mapping.

Returns:

An identifier for this VLAN mapping.

toVlanMapConfig

public VlanMapConfig toVlanMapConfig()

Convert this instance into a VlanMapConfig instance.

Returns:

A VlanMapConfig instance.

verify

public void verify()
            throws RpcException

Verify the contents of this instance.

Throws:

RpcException - Verification failed.

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.