no.nordicsemi.android.support.v18.scanner

Class ScanFilter

java.lang.Object

no.nordicsemi.android.support.v18.scanner.ScanFilter

All Implemented Interfaces:

android.os.Parcelable

public final class ScanFilter
extends Object
implements android.os.Parcelable

Criteria for filtering result from Bluetooth LE scans. A ScanFilter allows clients to restrict scan results to only those that are of interest to them.

Current filtering on the following fields are supported:

• Service UUIDs which identify the bluetooth gatt services running on the device.
• Name of remote Bluetooth LE device.
• Mac address of the remote device.
• Service data which is the data associated with a service.
• Manufacturer specific data which is the data associated with a particular manufacturer.

See Also:

ScanResult, BluetoothLeScannerCompat

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScanFilter.Builder Builder class for ScanFilter.

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<ScanFilter>	CREATOR A Parcelable.Creator to create ScanFilter from parcel.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(Object obj)
String	getDeviceAddress()
String	getDeviceName() Returns the filter set the device name field of Bluetooth advertisement data.
byte[]	getManufacturerData()
byte[]	getManufacturerDataMask()
int	getManufacturerId() Returns the manufacturer id.
byte[]	getServiceData()
byte[]	getServiceDataMask()
android.os.ParcelUuid	getServiceDataUuid()
android.os.ParcelUuid	getServiceUuid() Returns the filter set on the service uuid.
android.os.ParcelUuid	getServiceUuidMask()
int	hashCode()
boolean	matches(ScanResult scanResult) Check if the scan filter matches a scanResult.
String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<ScanFilter> CREATOR

A Parcelable.Creator to create ScanFilter from parcel.

Method Detail

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

getDeviceName

public String getDeviceName()

Returns the filter set the device name field of Bluetooth advertisement data.

getServiceUuid

public android.os.ParcelUuid getServiceUuid()

Returns the filter set on the service uuid.

getServiceUuidMask

public android.os.ParcelUuid getServiceUuidMask()

getDeviceAddress

public String getDeviceAddress()

getServiceData

public byte[] getServiceData()

getServiceDataMask

public byte[] getServiceDataMask()

getServiceDataUuid

public android.os.ParcelUuid getServiceDataUuid()

getManufacturerId

public int getManufacturerId()

Returns the manufacturer id. -1 if the manufacturer filter is not set.

getManufacturerData

public byte[] getManufacturerData()

getManufacturerDataMask

public byte[] getManufacturerDataMask()

matches

public boolean matches(ScanResult scanResult)

Check if the scan filter matches a scanResult. A scan result is considered as a match if it matches all the field filters.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object