ej.bluetooth.util

Class AdvertisementData

java.lang.Object

ej.bluetooth.util.AdvertisementData

public class AdvertisementData
extends Object

The AdvertisementData class represents the content of a Bluetooth advertisement data payload.

This helper class may be used to parse the advertisement data received in the scan result callback, by using the parse method of this class.

This class may also be used in order to build an advertisement data payload which is used in the start advertising API, by using the constructor of this class, its set/add methods and finally its serialize method.

Constructor Summary

Constructors

Constructor and Description
AdvertisementData() Creates an advertisement data object with the default advertisement flags and no other content.

Method Summary

Modifier and Type	Method and Description
void	addManufacturerData(int manufacturerId, byte[] data) Adds manufacturer data associated with the given manufacturer ID to this advertisement data.
void	addServiceUuid(BluetoothUuid serviceUuid) Adds a service UUID.
short	getAppearance() Gets the appearance contained in this advertisement data.
String	getDeviceName() Gets the device name contained in this advertisement data.
byte	getFlags() Gets the advertisement flags contained in this advertisement data.
byte[]	getManufacturerData(int manufacturerId) Gets the manufacturer data associated with the given manufacturer ID contained in this advertisement data.
int	getNumServiceUuids() Gets the number of service UUIDs.
BluetoothUuid	getServiceUuid(int index) Gets the service UUID at the given index.
static AdvertisementData	parse(byte[] data) Parses the given advertisement data payload and returns an advertisement data object.
byte[]	serialize() Serializes this advertisement data into a byte array.
void	setAppearance(short appearance) Sets the appearance of this advertisement data.
void	setDeviceName(String deviceName) Sets the device name of this advertisement data.
void	setFlags(int flags) Sets the advertisement flags of this advertisement data.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdvertisementData

public AdvertisementData()

Creates an advertisement data object with the default advertisement flags and no other content.

Method Detail

addManufacturerData

public void addManufacturerData(int manufacturerId,
                                byte[] data)

Adds manufacturer data associated with the given manufacturer ID to this advertisement data.

Parameters:

manufacturerId - the manufacturer ID.

data - the manufacturer data.

addServiceUuid

public void addServiceUuid(BluetoothUuid serviceUuid)

Adds a service UUID.

Parameters:

serviceUuid - the service UUID.

getAppearance

public short getAppearance()

Gets the appearance contained in this advertisement data.

Returns:

the appearance, or 0 if it is not defined.

getDeviceName

@Nullable
public String getDeviceName()

Gets the device name contained in this advertisement data.

Returns:

the device name, or null if it is not defined.

getFlags

public byte getFlags()

Gets the advertisement flags contained in this advertisement data.

Returns:

the advertisement flags (see AdvertisementFlags).

getManufacturerData

@Nullable
public byte[] getManufacturerData(int manufacturerId)

Gets the manufacturer data associated with the given manufacturer ID contained in this advertisement data.

Parameters:

manufacturerId - the manufacturer ID.

Returns:

the manufacturer data associated with the given manufacturer ID, or null if it is not defined.

getNumServiceUuids

public int getNumServiceUuids()

Gets the number of service UUIDs.

Returns:

the number of service UUIDs.

getServiceUuid

public BluetoothUuid getServiceUuid(int index)

Gets the service UUID at the given index.

Parameters:

index - the index of the service UUID.

Returns:

the service UUID at the given index.

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getNumServiceUuids()).

parse

public static AdvertisementData parse(byte[] data)

Parses the given advertisement data payload and returns an advertisement data object.

Parameters:

data - the advertisement data payload.

Returns:

the advertisement data object.

serialize

public byte[] serialize()

Serializes this advertisement data into a byte array.

Returns:

the serialized payload.

setAppearance

public void setAppearance(short appearance)

Sets the appearance of this advertisement data.

Parameters:

appearance - the appearance.

setDeviceName

public void setDeviceName(String deviceName)

Sets the device name of this advertisement data.

Parameters:

deviceName - the device name.

setFlags

public void setFlags(int flags)

Sets the advertisement flags of this advertisement data.

Parameters:

flags - the advertisement flags (see AdvertisementFlags).