com.github.mob41.blapi.mac

Class Mac

java.lang.Object

com.github.mob41.blapi.mac.Mac

public class Mac
extends Object

A class that handles a MAC address in String and bytes array format

Author:

Anthony

Constructor Summary

Constructors

Constructor and Description
Mac(byte[] macBytes) Creates an instance representing the MAC address
Mac(String macStr) Creates an instance representing the MAC address

Method Summary

Modifier and Type	Method and Description
static String	bytesToMacStr(byte[] macBytes) Converts MAC address bytes into String
byte[]	getMac() Returns the MAC address in bytes array
String	getMacString() Returns the MAC address represented in String
static boolean	isMACValid(byte[] macBytes) Returns whether the specified MAC bytes array is valid with the following conditions: 1.
static byte[]	macStrToBytes(String macStr) Converts MAC address String into bytes
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Mac

public Mac(byte[] macBytes)
    throws MacFormatException

Creates an instance representing the MAC address

Parameters:

macBytes - The 6-byte MAC address in byte array

Throws:

MacFormatException - If the MAC address bytes array specified is not with length 6 or null

Mac

public Mac(String macStr)
    throws MacFormatException

Creates an instance representing the MAC address

Parameters:

macStr - MAC address represented in String seperated by cottons ( :) (e.g. 00:00:00:00:00:00)

Throws:

MacFormatException - If the MAC address does not have a valid format:

does not have a hex (e.g. 0f) in the macStr, or, does not have 6 hex separated by cottons (:), or, a null is specified

Method Detail

getMac

public byte[] getMac()

Returns the MAC address in bytes array

Returns:

MAC address in bytes array

getMacString

public String getMacString()

Returns the MAC address represented in String

Returns:

MAC address in String

macStrToBytes

public static byte[] macStrToBytes(String macStr)
                            throws MacFormatException

Converts MAC address String into bytes

Parameters:

macStr - The 6-byte MAC Address (00:00:00:00:00:00) in String separated by cottons (:)

Returns:

Converted MAC Address in bytes

Throws:

MacFormatException - If the MAC address does not have a valid format:

does not have a hex (e.g. 0f) in the macStr, or, does not have 6 hex separated by cottons (:), or, a null is specified

isMACValid

public static boolean isMACValid(byte[] macBytes)

Returns whether the specified MAC bytes array is valid with the following conditions:

1. macBytes not null
2. macBytes's length is equal to 6

Parameters:

macBytes - The byte array to be validated

Returns:

The validation result

bytesToMacStr

public static String bytesToMacStr(byte[] macBytes)
                            throws MacFormatException

Converts MAC address bytes into String

Parameters:

macBytes - The 6-byte MAC Address in byte array

Returns:

A MAC address String converted from the byte array

Throws:

MacFormatException - If the MAC address bytes array specified is not with length 6 or null

toString

public String toString()

Overrides:

toString in class Object