com.polidea.rxandroidble2.scan

Class ScanFilter.Builder

java.lang.Object

com.polidea.rxandroidble2.scan.ScanFilter.Builder

Enclosing class:

ScanFilter

public static final class ScanFilter.Builder
extends java.lang.Object

Builder class for ScanFilter.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ScanFilter	build() Build ScanFilter.
ScanFilter.Builder	setDeviceAddress(java.lang.String deviceAddress) Set filter on device address.
ScanFilter.Builder	setDeviceName(java.lang.String deviceName) Set filter on device name.
ScanFilter.Builder	setManufacturerData(int manufacturerId, byte[] manufacturerData) Set filter on on manufacturerData.
ScanFilter.Builder	setManufacturerData(int manufacturerId, byte[] manufacturerData, byte[] manufacturerDataMask) Set filter on partial manufacture data.
ScanFilter.Builder	setServiceData(android.os.ParcelUuid serviceDataUuid, byte[] serviceData) Set filtering on service data.
ScanFilter.Builder	setServiceData(android.os.ParcelUuid serviceDataUuid, byte[] serviceData, byte[] serviceDataMask) Set partial filter on service data.
ScanFilter.Builder	setServiceUuid(android.os.ParcelUuid serviceUuid) Set filter on service uuid.
ScanFilter.Builder	setServiceUuid(android.os.ParcelUuid serviceUuid, android.os.ParcelUuid uuidMask) Set filter on partial service uuid.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setDeviceName

public ScanFilter.Builder setDeviceName(java.lang.String deviceName)

Set filter on device name.

setDeviceAddress

public ScanFilter.Builder setDeviceAddress(java.lang.String deviceAddress)

Set filter on device address.

Parameters:

deviceAddress - The device Bluetooth address for the filter. It needs to be in the format of "01:02:03:AB:CD:EF". The device address can be validated using BluetoothAdapter.checkBluetoothAddress(java.lang.String).

Throws:

java.lang.IllegalArgumentException - If the deviceAddress is invalid.

setServiceUuid

public ScanFilter.Builder setServiceUuid(android.os.ParcelUuid serviceUuid)

Set filter on service uuid.

setServiceUuid

public ScanFilter.Builder setServiceUuid(android.os.ParcelUuid serviceUuid,
                                         android.os.ParcelUuid uuidMask)

Set filter on partial service uuid. The uuidMask is the bit mask for the serviceUuid. Set any bit in the mask to 1 to indicate a match is needed for the bit in serviceUuid, and 0 to ignore that bit.

Throws:

java.lang.IllegalArgumentException - If serviceUuid is null but uuidMask is not null.

setServiceData

public ScanFilter.Builder setServiceData(android.os.ParcelUuid serviceDataUuid,
                                         byte[] serviceData)

Set filtering on service data.

Throws:

java.lang.IllegalArgumentException - If serviceDataUuid is null.

setServiceData

public ScanFilter.Builder setServiceData(android.os.ParcelUuid serviceDataUuid,
                                         byte[] serviceData,
                                         byte[] serviceDataMask)

Set partial filter on service data. For any bit in the mask, set it to 1 if it needs to match the one in service data, otherwise set it to 0 to ignore that bit.

The serviceDataMask must have the same length of the serviceData.

Throws:

java.lang.IllegalArgumentException - If serviceDataUuid is null or serviceDataMask is null while serviceData is not or serviceDataMask and serviceData has different length.

setManufacturerData

public ScanFilter.Builder setManufacturerData(int manufacturerId,
                                              byte[] manufacturerData)

Set filter on on manufacturerData. A negative manufacturerId is considered as invalid id.

Note the first two bytes of the manufacturerData is the manufacturerId.

Throws:

java.lang.IllegalArgumentException - If the manufacturerId is invalid.

setManufacturerData

public ScanFilter.Builder setManufacturerData(int manufacturerId,
                                              byte[] manufacturerData,
                                              byte[] manufacturerDataMask)

Set filter on partial manufacture data. For any bit in the mask, set it the 1 if it needs to match the one in manufacturer data, otherwise set it to 0.

The manufacturerDataMask must have the same length of manufacturerData.

Throws:

java.lang.IllegalArgumentException - If the manufacturerId is invalid, or manufacturerData is null while manufacturerDataMask is not, or manufacturerData and manufacturerDataMask have different length.

build

public ScanFilter build()

Build ScanFilter.

Throws:

java.lang.IllegalArgumentException - If the filter cannot be built.