org.opendaylight.vtn.manager.internal.util.inventory

Class MacVlan

java.lang.Object

org.opendaylight.vtn.manager.internal.util.inventory.MacVlan

All Implemented Interfaces:

Comparable<MacVlan>

public final class MacVlan
extends Object
implements Comparable<MacVlan>

MacVlan class represents a pair of MAC address and VLAN ID.

Field Summary

Fields

Modifier and Type	Field and Description
static long	UNDEFINED A pseudo MAC address which represents undefined value.

Constructor Summary

Constructors

Constructor and Description
MacVlan(byte[] mac, int vlan) Construct a new instance.
MacVlan(long value) Construct a new insttance from a long integer which contains a MAC address and a VLAN ID.
MacVlan(long mac, int vlan) Construct a new instance.
MacVlan(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress mac, int vlan) Construct a new instance.
MacVlan(String value) Construct a new instance.
MacVlan(VlanHost vh) Construct a new instance.
MacVlan(VlanHostDesc vhd) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
void	checkMacMap() Ensure that this instance can be contained in a MAC mapping configuration This method implies verify().
int	compareTo(MacVlan mvlan) Compare two MacVlan instances numerically.
boolean	equals(Object o) Determine whether the given object is identical to this object.
long	getAddress() Return a long value which represents a MAC address.
DataFlowSource	getDataFlowSource() Return a DataFlowSource instance which represents this instance.
long	getEncodedValue() Return a long integer value encoded from a MAC address and a VLAN ID.
EtherAddress	getEtherAddress() Return a MAC adderss as an EtherAddress instance.
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress	getMacAddress() Return a MD-SAL MAC address.
SourceHostFlowsKey	getSourceHostFlowsKey() Return a SourceHostFlowsKey instance which represents this instance.
VlanHostDesc	getVlanHostDesc() Return a VlanHostDesc instance which represents this instance.
VlanHostDescList	getVlanHostDescList() Return a VlanHostDescList instance which represents this instance.
int	getVlanId() Return a VLAN ID.
int	hashCode() Return the hash code of this object.
String	toString() Return a string representation of this object.
void	verify() Verify the contents of this instance.

Methods inherited from class java.lang.Object

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

Field Detail

UNDEFINED

public static final long UNDEFINED

A pseudo MAC address which represents undefined value.

See Also:

Constant Field Values

Constructor Detail

MacVlan

public MacVlan(long value)

Construct a new insttance from a long integer which contains a MAC address and a VLAN ID.

• Bits from bit 11 to bit 0 (LSB) are treated as a VLAN ID.
• Bits from bit 59 to bit 12 are treated as a MAC address.

Parameters:

value - A long value which contains a MAC address and a VLAN ID.

MacVlan

public MacVlan(long mac,
               int vlan)

Construct a new instance.

Parameters:

mac - A long value which represents a MAC address. Only lower 48 bits in the value is used. UNDEFINED is treated as undefined value.

vlan - VLAN ID. Only lower 12 bits in the value is used.

MacVlan

public MacVlan(VlanHost vh)
        throws RpcException

Construct a new instance.

Parameters:

vh - A VlanHost instance.

Throws:

RpcException - An invalid value is specified to vh.

MacVlan

public MacVlan(VlanHostDesc vhd)
        throws RpcException

Construct a new instance.

This constructor is used to create a new instance for MAC mapping configuration.

Parameters:

vhd - A VlanHostDesc instance.

Throws:

RpcException - An invalid value is specified to vhd.

MacVlan

public MacVlan(String value)
        throws RpcException

Construct a new instance.

Parameters:

value - A string which represents a pair of MAC address and a VLAN ID. The given string must consist of a MAC address and VLAN ID (decimal) joined with "@". An empty MAC address is treated as MAC address is not specified.

Throws:

RpcException - An invalid value is specified to value.

MacVlan

public MacVlan(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress mac,
               int vlan)

Construct a new instance.

Parameters:

mac - A MAC address. null is treated as undefined value.

vlan - VLAN ID. Only lower 12 bits in the value is used.

MacVlan

public MacVlan(byte[] mac,
               int vlan)

Construct a new instance.

Parameters:

mac - A byte array which represents a MAC address. null and all-zeroed byte array are treated as undefined value.

vlan - VLAN ID. Only lower 12 bits in the value is used.

Method Detail

getAddress

public long getAddress()

Return a long value which represents a MAC address.

Returns:

A long value which represent a MAC address. UNDEFINED is returned if no MAC address is configured in this instance.

getMacAddress

public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getMacAddress()

Return a MD-SAL MAC address.

Returns:

A MacAddress instance. Note that null is returned if no MAC address is configured in this instance.

getEtherAddress

public EtherAddress getEtherAddress()

Return a MAC adderss as an EtherAddress instance.

Returns:

An EtherAddress instance. Note that null is returned if no MAC address is configured in this instance.

getVlanId

public int getVlanId()

Return a VLAN ID.

Returns:

VLAN ID.

getEncodedValue

public long getEncodedValue()

Return a long integer value encoded from a MAC address and a VLAN ID.

Lower 48-bits of the returned value keeps a MAC address. And higher 16-bits of the returned value keeps a VLAN ID.

Returns:

A long integer value encoded from a MAC address and a VLAN ID.

getDataFlowSource

public DataFlowSource getDataFlowSource()

Return a DataFlowSource instance which represents this instance.

Returns:

A DataFlowSource instance.

getSourceHostFlowsKey

public SourceHostFlowsKey getSourceHostFlowsKey()

Return a SourceHostFlowsKey instance which represents this instance.

Returns:

A SourceHostFlowsKey instance. Note that null is returned if no MAC address is configured in this instance.

getVlanHostDesc

public VlanHostDesc getVlanHostDesc()

Return a VlanHostDesc instance which represents this instance.

Returns:

A VlanHostDesc instance.

getVlanHostDescList

public VlanHostDescList getVlanHostDescList()

Return a VlanHostDescList instance which represents this instance.

Returns:

A VlanHostDescList instance.

verify

public void verify()
            throws RpcException

Verify the contents of this instance.

Throws:

RpcException - Verification failed.

checkMacMap

public void checkMacMap()
                 throws RpcException

Ensure that this instance can be contained in a MAC mapping configuration

This method implies verify().

Throws:

RpcException - This instance is not suitable for MAC mapping configuration.

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 String toString()

Return a string representation of this object.

Overrides:

toString in class Object

Returns:

A string representation of this object.

compareTo

public int compareTo(MacVlan mvlan)

Compare two MacVlan instances numerically.

This method compares MAC addresses in both objects first. If the same MAC address is configured in both objects, compares VLAN IDs in both objects.

Specified by:

compareTo in interface Comparable<MacVlan>

Parameters:

mvlan - A MacVlan instance to be compared.

Returns:

0 is returned if this instance is equal to the specified instance. A value less than 0 is returned if this instance is numerically less than the specified instance. A value greater than 0 is returned if this instance is numerically greater than the specified instance.