MacAddress

public final class MacAddress
extends Object implements Parcelable

java.lang.Object
   ↳ android.net.MacAddress


Representation of a MAC address. This class only supports 48 bits long addresses and does not support 64 bits long addresses. Instances of this class are immutable.

Summary

Constants

int TYPE_BROADCAST

Indicates a MAC address is the broadcast address.

int TYPE_MULTICAST

Indicates a MAC address is a multicast address.

int TYPE_UNICAST

Indicates a MAC address is a unicast address.

Inherited constants

Fields

public static final MacAddress BROADCAST_ADDRESS

The MacAddress representing the unique broadcast MAC address.

public static final Creator<MacAddress> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

static MacAddress fromBytes(byte[] addr)

Creates a MacAddress from the given byte array representation.

static MacAddress fromString(String addr)

Creates a MacAddress from the given String representation.

int getAddressType()

Returns the type of this address.

int hashCode()

Returns a hash code value for the object.

boolean isLocallyAssigned()
byte[] toByteArray()
String toOuiString()
String toString()

Returns a string representation of the object.

void writeToParcel(Parcel out, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

TYPE_BROADCAST

int TYPE_BROADCAST

Indicates a MAC address is the broadcast address.

Constant Value: 3 (0x00000003)

TYPE_MULTICAST

int TYPE_MULTICAST

Indicates a MAC address is a multicast address.

Constant Value: 2 (0x00000002)

TYPE_UNICAST

int TYPE_UNICAST

Indicates a MAC address is a unicast address.

Constant Value: 1 (0x00000001)

Fields

BROADCAST_ADDRESS

MacAddress BROADCAST_ADDRESS

The MacAddress representing the unique broadcast MAC address.

Public methods

describeContents

int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

equals

boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

fromBytes

MacAddress fromBytes (byte[] addr)

Creates a MacAddress from the given byte array representation. A valid byte array representation for a MacAddress is a non-null array of length 6.

Parameters
addr byte: a byte array representation of a MAC address.

This value must never be null.

Returns
MacAddress the MacAddress corresponding to the given byte array representation.

This value will never be null.

Throws
IllegalArgumentException if the given byte array is not a valid representation.

fromString

MacAddress fromString (String addr)

Creates a MacAddress from the given String representation. A valid String representation for a MacAddress is a series of 6 values in the range [0,ff] printed in hexadecimal and joined by ':' characters.

Parameters
addr String: a String representation of a MAC address.

This value must never be null.

Returns
MacAddress the MacAddress corresponding to the given String representation.

This value will never be null.

Throws
IllegalArgumentException if the given String is not a valid representation.

getAddressType

int getAddressType ()

Returns the type of this address.

Returns
int the int constant representing the MAC address type of this MacAddress.

Value is TYPE_UNICAST, TYPE_MULTICAST or TYPE_BROADCAST.

hashCode

int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

isLocallyAssigned

boolean isLocallyAssigned ()

Returns
boolean true if this MacAddress is a locally assigned address.

toByteArray

byte[] toByteArray ()

Returns
byte[] a byte array representation of this MacAddress.

This value will never be null.

toOuiString

String toOuiString ()

Returns
String a String representation of the OUI part of this MacAddress made of 3 hexadecimal numbers in [0,ff] joined by ':' characters.

This value will never be null.

toString

String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

This value will never be null.

writeToParcel

void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.

Parameters
out Parcel: The Parcel in which the object should be written.

flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.