ScanFilter (rxandroidble 1.10.1 API)

java.lang.Object
- com.polidea.rxandroidble2.scan.ScanFilter

All Implemented Interfaces:

android.os.Parcelable, ScanFilterInterface
```
public class ScanFilter
extends java.lang.Object
implements android.os.Parcelable, ScanFilterInterface
```
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, https://code.google.com/p/android/issues/detail?id=180675 https://code.google.com/p/android/issues/detail?id=181561 https://code.google.com/p/android/issues/detail?id=313221

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>

Nested Classes
Modifier and Type	Class and Description
`static class`	`ScanFilter.Builder` Builder class for `ScanFilter`.

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`describeContents()`
`static ScanFilter`	`empty()` A function that returns an empty filter
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getDeviceAddress()`
`java.lang.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`	`isAllFieldsEmpty()` Checks if the scanfilter is empty
`boolean`	`matches(RxBleInternalScanResult scanResult)` Check if the scan filter matches a `scanResult`.
`java.lang.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 java.lang.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 java.lang.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(RxBleInternalScanResult scanResult)
```
    Check if the scan filter matches a scanResult. A scan result is considered as a match if it matches all the field filters.
    
    Specified by:
    
    matches in interface ScanFilterInterface
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - isAllFieldsEmpty
```
public boolean isAllFieldsEmpty()
```
    Checks if the scanfilter is empty
    
    Specified by:
    
    isAllFieldsEmpty in interface ScanFilterInterface
  - empty
```
public static ScanFilter empty()
```
    A function that returns an empty filter
    
    Returns:
    
    an empty filter

Class ScanFilter

Nested Class Summary

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

Field Summary

Fields inherited from interface android.os.Parcelable

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CREATOR

Method Detail

describeContents

writeToParcel

getDeviceName

getServiceUuid

getServiceUuidMask

getDeviceAddress

getServiceData

getServiceDataMask

getServiceDataUuid

getManufacturerId

getManufacturerData

getManufacturerDataMask

matches

toString

hashCode

equals

isAllFieldsEmpty

empty