org.opendaylight.vtn.manager.util

Class EtherAddress

java.lang.Object

org.opendaylight.vtn.manager.util.EtherAddress

All Implemented Interfaces:

Serializable

public final class EtherAddress
extends Object
implements Serializable

EtherAddress describes an ethernet address, aka MAC address.

Since:

Lithium

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	BIT_MULTICAST Multicast bit in the first octet.
static EtherAddress	BROADCAST A EtherAddress instance which represents a broadcast address.
static long	MASK_MULTICAST A mask value that indicates the multicast bit in the first octet.
static int	SIZE The number of octets in an ethernet address.

Constructor Summary

Constructors

Constructor and Description
EtherAddress(byte[] bytes) Construct a new instance.
EtherAddress(long addr) Construct a new instance.
EtherAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress mac) Construct a new instance.
EtherAddress(String hex) Construct a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
static EtherAddress	create(byte[] bytes) Create a new EtherAddress instance.
static EtherAddress	create(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress mac) Create a new EtherAddress instance.
static EtherAddress	create(org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.MacAddressFilter mf) Create a new EtherAddress instance.
static EtherAddress	create(String hex) Create a new EtherAddress instance.
boolean	equals(Object o) Determine whether the given object is identical to this object.
long	getAddress() Return a long number which represents this ethernet address.
byte[]	getBytes() Return a byte array which represents this ethernet address.
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress	getMacAddress() Return a MacAddress instance which represents this ethernet address.
String	getText() Return a hex string which represents this ethernet address.
int	hashCode() Return the hash code of this object.
boolean	isBroadcast() Determine whether this instance represents a broadcast address or not.
static boolean	isBroadcast(byte[] bytes) Determine whether the given byte array represents a broadcast address or not.
boolean	isUnicast() Determine whether this instance represents an unicast address or not.
static boolean	isUnicast(byte[] bytes) Determine whether the given byte array represents an unicast address or not.
static byte[]	toBytes(long addr) Convert a long number which represents an ethernet address into a byte array.
static byte[]	toBytes(String hex) Convert a string representation of an ethernet address into a byte array.
static long	toLong(byte[] b) Convert the given byte array that represents an ethernet address into a long integer number.
static long	toLong(String hex) Convert a string representation of an ethernet address into a long integer number.
String	toString() Return a string representation of this object.

Methods inherited from class java.lang.Object

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

Field Detail

SIZE

public static final int SIZE

The number of octets in an ethernet address.

See Also:

Constant Field Values

BIT_MULTICAST

public static final int BIT_MULTICAST

Multicast bit in the first octet.

See Also:

Constant Field Values

MASK_MULTICAST

public static final long MASK_MULTICAST

A mask value that indicates the multicast bit in the first octet.

See Also:

Constant Field Values

BROADCAST

public static final EtherAddress BROADCAST

A EtherAddress instance which represents a broadcast address.

Constructor Detail

EtherAddress

public EtherAddress(long addr)

Construct a new instance.

Parameters:

addr - A long integer value which represents an ethernet address.

EtherAddress

public EtherAddress(byte[] bytes)

Construct a new instance.

Parameters:

bytes - A byte array which represents an ethernet address.

Throws:

NullPointerException - bytes is null.

IllegalArgumentException - The length of bytes is not 6.

EtherAddress

public EtherAddress(String hex)

Construct a new instance.

Parameters:

hex - A hex string which represents an ethernet address.

Throws:

NullPointerException - hex is null.

IllegalArgumentException - The given string is not a string representation of an ethernet address.

EtherAddress

public EtherAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress mac)

Construct a new instance.

Parameters:

mac - A MacAddress instance.

Throws:

NullPointerException - mac is null.

IllegalArgumentException - The given instance contains an invalid value.

Method Detail

toLong

public static long toLong(byte[] b)

Convert the given byte array that represents an ethernet address into a long integer number.

Parameters:

b - A byte array.

Returns:

A long integer number.

Throws:

NullPointerException - b is null.

IllegalArgumentException - The length of b is not 6.

toLong

public static long toLong(String hex)

Convert a string representation of an ethernet address into a long integer number.

Parameters:

hex - A hex string which represents an ethernet address.

Returns:

A long integer number.

Throws:

NullPointerException - hex is null.

NumberFormatException - The given string is not a hex string.

IllegalArgumentException - The given string is not a string representation of an ethernet address.

toBytes

public static byte[] toBytes(long addr)

Convert a long number which represents an ethernet address into a byte array.

Parameters:

addr - A long integer which represents an byte array.

Returns:

A byte array that contains 6 octets.

toBytes

public static byte[] toBytes(String hex)

Convert a string representation of an ethernet address into a byte array.

Parameters:

hex - A hex string which represents an ethernet address.

Returns:

A byte array that contains 6 octets if a valid hex string is passed. null is returned if null is passed.

Throws:

IllegalArgumentException - The given string is not a string representation of an ethernet address.

isBroadcast

public static boolean isBroadcast(byte[] bytes)

Determine whether the given byte array represents a broadcast address or not.

Parameters:

bytes - A byte array to be tested.

Returns:

true only if the given byte array represents a broadcast address.

isUnicast

public static boolean isUnicast(byte[] bytes)

Determine whether the given byte array represents an unicast address or not.

Parameters:

bytes - A byte array to be tested.

Returns:

true only if the given byte array represents an unicast address.

create

public static EtherAddress create(byte[] bytes)

Create a new EtherAddress instance.

Parameters:

bytes - A byte array which represents an ethernet address.

Returns:

An EtherAddress instance if bytes is not null. null if bytes is null.

Throws:

IllegalArgumentException - The length of bytes is not 6.

create

public static EtherAddress create(String hex)

Create a new EtherAddress instance.

Parameters:

hex - A hex string which represents an ethernet address.

Returns:

An EtherAddress instance if hex is not null. null if hex is null.

Throws:

IllegalArgumentException - The given string is not a string representation of an ethernet address.

create

public static EtherAddress create(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress mac)

Create a new EtherAddress instance.

Parameters:

mac - A MacAddress instance.

Returns:

An EtherAddress instance if mac is not null. null if mac is null.

Throws:

IllegalArgumentException - The given instance contains an invalid value.

create

public static EtherAddress create(org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.MacAddressFilter mf)

Create a new EtherAddress instance.

Parameters:

mf - A MacAddressFilter instance. Note that MAC address mask is always ignored.

Returns:

An EtherAddress instance if a valid MAC address is configured in mf. Otherwise null.

Throws:

IllegalArgumentException - The given instance contains an invalid value.

getAddress

public long getAddress()

Return a long number which represents this ethernet address.

Returns:

A long number.

getBytes

public byte[] getBytes()

Return a byte array which represents this ethernet address.

Returns:

A byte array.

getMacAddress

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

Return a MacAddress instance which represents this ethernet address.

Returns:

A MacAddress instance.

getText

public String getText()

Return a hex string which represents this ethernet address.

Note that below description of return value of this method is written for REST API document.

Returns:

A string representation of a MAC address.

A MAC address is represented by hexadecimal notation with ':' inserted between octets. (e.g. "11:22:33:aa:bb:cc")

isBroadcast

public boolean isBroadcast()

Determine whether this instance represents a broadcast address or not.

Returns:

true only if this instance represents a broadcast address.

isUnicast

public boolean isUnicast()

Determine whether this instance represents an unicast address or not.

Returns:

true only if this instance represents an unicast address.

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.