DeviceId.Builder


public static final class DeviceId.Builder
extends Object

java.lang.Object
   ↳ android.companion.DeviceId.Builder


A builder for DeviceId

Calling apps must provide at least one of the following to identify the device: a custom ID using setCustomId(java.lang.String), or a MAC address using setMacAddress(android.net.MacAddress).

Summary

Public constructors

Builder()

Public methods

DeviceId build()
DeviceId.Builder setCustomId(String customId)

Sets the custom device id.

DeviceId.Builder setMacAddress(MacAddress macAddress)

Sets the mac address.

Inherited methods

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 timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Builder

public Builder ()

Public methods

build

public DeviceId build ()

Returns
DeviceId This value cannot be null.

setCustomId

public DeviceId.Builder setCustomId (String customId)

Sets the custom device id. This id is used by the Companion app to identify a specific device.

Parameters
customId String: the custom device id This value may be null.

Returns
DeviceId.Builder This value cannot be null.

Throws
IllegalArgumentException length of the custom id must more than 1024 characters to save disk space.

setMacAddress

public DeviceId.Builder setMacAddress (MacAddress macAddress)

Sets the mac address. This mac address is used by the Companion app to identify a specific device.

Parameters
macAddress MacAddress: the remote device mac address This value may be null.

Returns
DeviceId.Builder This value cannot be null.

Throws
IllegalArgumentException length of the custom id must more than 1024 characters to save disk space.