Skip to content

Most visited

Recently visited

navigation

ScanFilter

public final class ScanFilter
extends Object implements Parcelable

java.lang.Object
   ↳ android.bluetooth.le.ScanFilter


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:

    Summary

    Nested classes

    class ScanFilter.Builder

    Builder class for ScanFilter

    Inherited constants

    From interface android.os.Parcelable

    Fields

    public static final Creator<ScanFilter> CREATOR

    A Parcelable.Creator to create ScanFilter from parcel.

    Public methods

    int describeContents()

    Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

    boolean equals(Object obj)

    Indicates whether some other object is "equal to" this one.

    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()
    ParcelUuid getServiceDataUuid()
    ParcelUuid getServiceUuid()

    Returns the filter set on the service uuid.

    ParcelUuid getServiceUuidMask()
    int hashCode()

    Returns a hash code value for the object.

    boolean matches(ScanResult scanResult)

    Check if the scan filter matches a scanResult.

    String toString()

    Returns a string representation of the object.

    void writeToParcel(Parcel dest, int flags)

    Flatten this object in to a Parcel.

    Inherited methods

    From class java.lang.Object
    From interface android.os.Parcelable

    Fields

    CREATOR

    added in API level 21
    Creator<ScanFilter> CREATOR

    A Parcelable.Creator to create ScanFilter from parcel.

    Public methods

    describeContents

    added in API level 21
    int describeContents ()

    Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

    Returns
    int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

    equals

    added in API level 21
    boolean equals (Object obj)

    Indicates whether some other object is "equal to" this one.

    The equals method implements an equivalence relation on non-null object references:

    • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
    • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
    • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
    • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
    • For any non-null reference value x, x.equals(null) should return false.

    The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

    Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

    Parameters
    obj Object: the reference object with which to compare.

    Returns
    boolean true if this object is the same as the obj argument; false otherwise.

    getDeviceAddress

    added in API level 21
    String getDeviceAddress ()

    Returns
    String

    This value may be null.

    getDeviceName

    added in API level 21
    String getDeviceName ()

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

    Returns
    String

    This value may be null.

    getManufacturerData

    added in API level 21
    byte[] getManufacturerData ()

    Returns
    byte[]

    This value may be null.

    getManufacturerDataMask

    added in API level 21
    byte[] getManufacturerDataMask ()

    Returns
    byte[]

    This value may be null.

    getManufacturerId

    added in API level 21
    int getManufacturerId ()

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

    Returns
    int

    getServiceData

    added in API level 21
    byte[] getServiceData ()

    Returns
    byte[]

    This value may be null.

    getServiceDataMask

    added in API level 21
    byte[] getServiceDataMask ()

    Returns
    byte[]

    This value may be null.

    getServiceDataUuid

    added in API level 21
    ParcelUuid getServiceDataUuid ()

    Returns
    ParcelUuid

    This value may be null.

    getServiceUuid

    added in API level 21
    ParcelUuid getServiceUuid ()

    Returns the filter set on the service uuid.

    Returns
    ParcelUuid

    This value may be null.

    getServiceUuidMask

    added in API level 21
    ParcelUuid getServiceUuidMask ()

    Returns
    ParcelUuid

    This value may be null.

    hashCode

    added in API level 21
    int hashCode ()

    Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

    The general contract of hashCode is:

    • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
    • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
    • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

    As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

    Returns
    int a hash code value for this object.

    matches

    added in API level 21
    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.

    Parameters
    scanResult ScanResult

    Returns
    boolean

    toString

    added in API level 21
    String toString ()

    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

    The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

     getClass().getName() + '@' + Integer.toHexString(hashCode())
     

    Returns
    String a string representation of the object.

    writeToParcel

    added in API level 21
    void writeToParcel (Parcel dest, 
                    int flags)

    Flatten this object in to a Parcel.

    Parameters
    dest Parcel: The Parcel in which the object should be written.

    flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

  • This site uses cookies to store your preferences for site-specific language and display options.

    Get the latest Android developer news and tips that will help you find success on Google Play.

    * Required Fields

    Hooray!

    Browse this site in ?

    You requested a page in , but your language preference for this site is .

    Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

    This class requires API level or higher

    This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

    For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

    Take a short survey?
    Help us improve the Android developer experience.
    (Sep 2017 survey)