MacAddress (sdn-apidoc 2.5.14 API)

java.lang.Object
- com.hp.util.cache.CacheableDataType
- - com.hp.util.ip.MacAddress

All Implemented Interfaces:

Serializable, Comparable<MacAddress>
```
public final class MacAddress
extends CacheableDataType
implements Comparable<MacAddress>
```
Represents a MAC address.
All constructors for this class are private. Creating instances of MacAddress is done via the static methods on the class.
Instances of this class are immutable, making them inherently threadsafe.
This class overrides equals(java.lang.Object) and hashCode() so that instances play nicely with the Collection classes.
This class implements the Comparable interface to ensure that a sorted list of addresses is presented in an intuitive order.

Author:

Simon Hunt

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MacAddress.Format
Designates the different MAC address string formats available.

Nested Classes
Modifier and Type	Class and Description
`static class`	`MacAddress.Format` Designates the different MAC address string formats available.

Field Summary

Fields
Modifier and Type	Field and Description
`static MacAddress`	`BROADCAST` The broadcast address, that is ff:ff:ff:ff:ff:ff.
`static MacAddress`	`HSDP_MULTICAST` The multicast destination address for discovery packets./
`static MacAddress`	`LINK_LOCAL_00` The link local address ending in 00, that is 01:80:c2:00:00:00.
`static MacAddress`	`LINK_LOCAL_03` The link local address ending in 03, that is 01:80:c2:00:00:03.
`static MacAddress`	`LINK_LOCAL_0E` The link local address ending in 0E, that is 01:80:c2:00:00:0e.
`static int`	`MAC_ADDR_SIZE` Number of bytes for a MAC address.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(MacAddress o)` Implements the Comparable interface, to return addresses in natural order.
`boolean`	`equals(Object o)`
`String`	`getEthernetCompany()` Returns the ethernet company name that this MAC address is associated with.
`int`	`hashCode()`
`void`	`intoBuffer(ByteBuffer b)` Writes the bytes that represent the MAC address directly into `ByteBuffer` at the buffer's current position.
`boolean`	`isBroadcast()` Returns true if this is the broadcast address (FF:FF:FF:FF:FF:FF).
`boolean`	`isLinkLocal()` Returns true if this is one of the "Link Local" addresses.
`boolean`	`isMulticast()` Returns true if this is a multicast address.
`boolean`	`isVrrpVmac()` Returns true if this is a VMAC used by VRRP.
`static MacAddress`	`mac(byte[] bytes)` Convenience method that simply delegates to `valueOf(byte[])`.
`static MacAddress`	`mac(long encodedAddress)` Convenience method that simply delegates to `valueOf(long)`.
`static MacAddress`	`mac(String address)` Convenience method that simply delegates to `valueOf(String)`.
`byte[]`	`toByteArray()` Returns a newly allocated byte array containing bytes that represent the MAC address.
`String`	`toFormattedString(MacAddress.Format fmt)` Returns a string representation of this MAC address, using the specified `MacAddress.Format`.
`String`	`toFormattedString(MacAddress.Format fmt, boolean toLowerCase)` Returns a string representation of this MAC address, using the specified `MacAddress.Format`.
`long`	`toLong()` Returns the MAC address represented as a long.
`String`	`toString()` Returns a string representation of this MAC address in "XX:XX:XX:XX:XX:XX" form.
`static MacAddress`	`valueFrom(ByteBuffer buffer)` Reads 6 bytes from the specified byte buffer and creates a MAC address entity.
`static MacAddress`	`valueOf(byte[] bytes)` Returns an object that represents the value of the MAC address defined by the specified address bytes.
`static MacAddress`	`valueOf(long encodedAddress)` Returns an object that represents the value of the MAC address encoded by the specified long value.
`static MacAddress`	`valueOf(String address)` Returns an object that represents the value of the MAC address defined by the specified string.

Methods inherited from class com.hp.util.cache.CacheableDataType
getRefQ, keyFromBytes

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MAC_ADDR_SIZE
```
public static final int MAC_ADDR_SIZE
```
    Number of bytes for a MAC address.
    
    See Also:
    Constant Field Values
  - BROADCAST
```
public static final MacAddress BROADCAST
```
    The broadcast address, that is ff:ff:ff:ff:ff:ff.
  - LINK_LOCAL_0E
```
public static final MacAddress LINK_LOCAL_0E
```
    The link local address ending in 0E, that is 01:80:c2:00:00:0e.
  - LINK_LOCAL_03
```
public static final MacAddress LINK_LOCAL_03
```
    The link local address ending in 03, that is 01:80:c2:00:00:03.
  - LINK_LOCAL_00
```
public static final MacAddress LINK_LOCAL_00
```
    The link local address ending in 00, that is 01:80:c2:00:00:00.
  - HSDP_MULTICAST
```
public static final MacAddress HSDP_MULTICAST
```
    The multicast destination address for discovery packets./
- Method Detail
  - getEthernetCompany
```
public String getEthernetCompany()
```
    Returns the ethernet company name that this MAC address is associated with. This is done by looking at the top 3 bytes of the address and returning the name of the company that has been assigned that byte pattern.
    A value of "(Unknown)" will be returned if no known mapping exists.
    
    Returns:
    the ethernet company name
  - toString
```
public String toString()
```
    Returns a string representation of this MAC address in "XX:XX:XX:XX:XX:XX" form.
    This is the same result as invoking macAddr.toFormattedString(MacAddress.Format.MULTI_COLON).
    
    Overrides:
    
    toString in class Object
    
    Returns:
    the MAC address as a string
  - toFormattedString
```
public String toFormattedString(MacAddress.Format fmt)
```
    Returns a string representation of this MAC address, using the specified MacAddress.Format.
    - Format.MULTI_COLON => "XX:XX:XX:XX:XX:XX"
    - Format.MULTI_DASH => "XX-XX-XX-XX-XX-XX"
    - Format.SINGLE_COLON => "XXXXXX:XXXXXX"
    - Format.SINGLE_DASH => "XXXXXX-XXXXXX"
    - Format.NO_DELIMITER => "XXXXXXXXXXXX"
    where each "X" is a hex digit
    Parameters:
    fmt - the format to use
    
    Returns:
    the formatted address
  - toFormattedString
```
public String toFormattedString(MacAddress.Format fmt,
                       boolean toLowerCase)
```
    Returns a string representation of this MAC address, using the specified MacAddress.Format.
    - Format.MULTI_COLON => "XX:XX:XX:XX:XX:XX"
    - Format.MULTI_DASH => "XX-XX-XX-XX-XX-XX"
    - Format.SINGLE_COLON => "XXXXXX:XXXXXX"
    - Format.SINGLE_DASH => "XXXXXX-XXXXXX"
    - Format.NO_DELIMITER => "XXXXXXXXXXXX"
    where each "X" is a hex digit
    Parameters:
    fmt - the format to use
    toLowerCase - if true, hex digits will be lowercase
    
    Returns:
    the formatted address
  - isBroadcast
```
public boolean isBroadcast()
```
    Returns true if this is the broadcast address (FF:FF:FF:FF:FF:FF).
    
    Returns:
    true if this is the broadcast address
  - isMulticast
```
public boolean isMulticast()
```
    Returns true if this is a multicast address. That is, if the least significant bit of the most significant byte is 1.
    
    Returns:
    true if this is a multicast address
  - isLinkLocal
```
public boolean isLinkLocal()
```
    Returns true if this is one of the "Link Local" addresses. That is, if the address is one of the following:
    - 01:80:c2:00:00:0e
    - 01:80:c2:00:00:03
    - 01:80:c2:00:00:00
    cf. Link Layer Discovery Protocol (LLDP)
    Returns:
    true if this is a link local address
  - isVrrpVmac
```
public boolean isVrrpVmac()
```
    Returns true if this is a VMAC used by VRRP. That is, if the the address has MSB 5 Bytes as 00-00-5E-00-01
    
    Returns:
    true if this is a VMAC address used by VRRP
  - toByteArray
```
public byte[] toByteArray()
```
    Returns a newly allocated byte array containing bytes that represent the MAC address. Note that the address bytes are in network byte order; that is, the highest order byte of the address is at index 0.
    
    Returns:
    a byte array representing the MAC address
  - intoBuffer
```
public void intoBuffer(ByteBuffer b)
```
    Writes the bytes that represent the MAC address directly into ByteBuffer at the buffer's current position. Note that the address bytes are in network byte order; that is, the highest order byte of the address is at index 0.
    
    Parameters:
    b - the byte buffer to write into
  - toLong
```
public long toLong()
```
    Returns the MAC address represented as a long.
    This method is provided to support the encoding of MAC addresses as long values.
    
    Returns:
    the MAC encoded as a long
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(MacAddress o)
```
    Implements the Comparable interface, to return addresses in natural order.
    
    Specified by:
    
    compareTo in interface Comparable<MacAddress>
    
    Parameters:
    o - the other MAC address
    
    Returns:
    an integer value indicating the relative ordering
    See Also:
    Comparable.compareTo(T)
  - valueOf
```
public static MacAddress valueOf(byte[] bytes)
```
    Returns an object that represents the value of the MAC address defined by the specified address bytes. Note that the address bytes are presumed to be in network byte order; that is, the highest order byte of the address is at index 0. The array length is expected to be 6. An exception is thrown if it is not.
    
    Parameters:
    bytes - the MAC address bytes
    
    Returns:
    a MacAddress instance
    
    Throws:
    
    NullPointerException - if the parameter is null
    
    IllegalArgumentException - if bytes length is not 6
  - mac
```
public static MacAddress mac(byte[] bytes)
```
    Convenience method that simply delegates to valueOf(byte[]).
    
    Parameters:
    bytes - the MAC address bytes
    
    Returns:
    a MacAddress instance
    
    Throws:
    
    NullPointerException - if the parameter is null
    
    IllegalArgumentException - if bytes length is not 6
  - valueOf
```
public static MacAddress valueOf(String address)
```
    Returns an object that represents the value of the MAC address defined by the specified string. Both uppercase and lowercase hex digits are allowed.
    Acceptable input formats are:
    - "XX:XX:XX:XX:XX:XX"
    - "XX-XX-XX-XX-XX-XX"
    - "XXXXXX:XXXXXX"
    - "XXXXXX-XXXXXX"
    - "XXXXXXXXXXXX"
    where each "X" represents a hex digit
    Parameters:
    address - the string representation of the MAC address
    
    Returns:
    a MacAddress instance
    
    Throws:
    
    NullPointerException - if address is null
    
    IllegalArgumentException - if address is not an acceptable format
  - mac
```
public static MacAddress mac(String address)
```
    Convenience method that simply delegates to valueOf(String).
    
    Parameters:
    address - the string representation of the MAC address
    
    Returns:
    a MacAddress instance
    
    Throws:
    
    NullPointerException - if address is null
    
    IllegalArgumentException - if address is not an acceptable format
  - valueOf
```
public static MacAddress valueOf(long encodedAddress)
```
    Returns an object that represents the value of the MAC address encoded by the specified long value.
    
    Parameters:
    encodedAddress - the encoded MAC address
    
    Returns:
    a MacAddress instance
    
    Throws:
    
    IllegalArgumentException - if the specified long is not a valid encodement
  - mac
```
public static MacAddress mac(long encodedAddress)
```
    Convenience method that simply delegates to valueOf(long).
    
    Parameters:
    encodedAddress - the encoded MAC address
    
    Returns:
    a MacAddress instance
    
    Throws:
    
    IllegalArgumentException - if the specified long is not a valid encodement
  - valueFrom
```
public static MacAddress valueFrom(ByteBuffer buffer)
```
    Reads 6 bytes from the specified byte buffer and creates a MAC address entity.
    
    Parameters:
    buffer - byte buffer from which to read the bytes
    
    Returns:
    a MacAddress instance
    
    Throws:
    
    BufferUnderflowException - if the buffer does not have 6 bytes remaining

Class MacAddress

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class com.hp.util.cache.CacheableDataType

Methods inherited from class java.lang.Object

Field Detail

MAC_ADDR_SIZE

BROADCAST

LINK_LOCAL_0E

LINK_LOCAL_03

LINK_LOCAL_00

HSDP_MULTICAST

Method Detail

getEthernetCompany

toString

toFormattedString

toFormattedString

isBroadcast

isMulticast

isLinkLocal

isVrrpVmac

toByteArray

intoBuffer

toLong

equals

hashCode

compareTo

valueOf

mac

valueOf

mac

valueOf

mac

valueFrom