Most visited

Recently visited

Results for

Summary: Constants | Inherited Constants | Fields | Methods | Inherited Methods

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. This class provides implementations of hashCode() and equals() that make it suitable for use as keys in standard implementations of Map.

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

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

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.
`Inet6Address`	`getLinkLocalIpv6FromEui48Mac()` Create a link-local Inet6Address from the MAC address.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isLocallyAssigned()`
`boolean`	`matches(MacAddress baseAddress, MacAddress mask)` Checks if this MAC Address matches the provided range.
`byte[]`	`toByteArray()` Convert this MacAddress to a byte array.
`String`	`toOuiString()`
`String`	`toString()` Returns a human-readable representation of this MacAddress.
`void`	`writeToParcel(Parcel out, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

TYPE_BROADCAST

public static final int TYPE_BROADCAST

Indicates a MAC address is the broadcast address.

Constant Value: 3 (0x00000003)

TYPE_MULTICAST

public static final int TYPE_MULTICAST

Indicates a MAC address is a multicast address.

Constant Value: 2 (0x00000002)

TYPE_UNICAST

public static final int TYPE_UNICAST

Indicates a MAC address is a unicast address.

Constant Value: 1 (0x00000001)

Fields

BROADCAST_ADDRESS

public static final MacAddress BROADCAST_ADDRESS

The MacAddress representing the unique broadcast MAC address.

CREATOR

public static final Creator<MacAddress> CREATOR

Public methods

describeContents

public 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(android.os.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. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

equals

public 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

public static 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 cannot be `null`.

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

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

fromString

public static 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 cannot be `null`.

Returns
`MacAddress`	the MacAddress corresponding to the given String representation. This value cannot be `null`.

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

getAddressType

public int getAddressType ()

Returns the type of this address.

Returns
`int`	the int constant representing the MAC address type of this MacAddress. Value is android.net.MacAddress.TYPE_UNKNOWN, `TYPE_UNICAST`, `TYPE_MULTICAST`, or `TYPE_BROADCAST`

getLinkLocalIpv6FromEui48Mac

public Inet6Address getLinkLocalIpv6FromEui48Mac ()

Create a link-local Inet6Address from the MAC address. The EUI-48 MAC address is converted to an EUI-64 MAC address per RFC 4291. The resulting EUI-64 is used to construct a link-local IPv6 address per RFC 4862.

Returns
`Inet6Address`	A link-local Inet6Address constructed from the MAC address. This value may be `null`.

hashCode

public 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

public boolean isLocallyAssigned ()

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

matches

public boolean matches (MacAddress baseAddress, 
                MacAddress mask)

Checks if this MAC Address matches the provided range.

Parameters
`baseAddress`	`MacAddress`: MacAddress representing the base address to compare with. This value cannot be `null`.
`mask`	`MacAddress`: MacAddress representing the mask to use during comparison. This value cannot be `null`.

Returns
`boolean`	true if this MAC Address matches the given range.

toByteArray

public byte[] toByteArray ()

Convert this MacAddress to a byte array. The returned array is in network order. For example, if this MacAddress is 1:2:3:4:5:6, the returned array is [1, 2, 3, 4, 5, 6].

Returns
`byte[]`	a byte array representation of this MacAddress. This value cannot be `null`.

toOuiString

public 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 cannot be `null`.

toString

public String toString ()

Returns a human-readable representation of this MacAddress. The exact format is implementation-dependent and should not be assumed to have any particular format.

Returns
`String`	This value cannot be `null`.

writeToParcel

public 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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Interfaces

Classes

Enums

Exceptions

Most visited

Recently visited

Results for

MacAddress

Summary

Constants

Inherited constants

Fields

Public methods

Inherited methods

Constants

TYPE_BROADCAST

TYPE_MULTICAST

TYPE_UNICAST

Fields

BROADCAST_ADDRESS

CREATOR

Public methods

describeContents

equals

fromBytes

fromString

getAddressType

getLinkLocalIpv6FromEui48Mac

hashCode

isLocallyAssigned

matches

toByteArray

toOuiString

toString

writeToParcel