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:
See also:
Summary
Nested classes | |
---|---|
class |
ScanFilter.Builder
Builder class for |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<ScanFilter> |
CREATOR
A |
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. |
byte[]
|
getAdvertisingData()
Returns the advertising data of this filter. |
byte[]
|
getAdvertisingDataMask()
Returns the advertising data mask of this filter. |
int
|
getAdvertisingDataType()
Returns the advertising data type of this filter. |
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
|
getServiceSolicitationUuid()
Returns the filter set on the service Solicitation uuid. |
ParcelUuid
|
getServiceSolicitationUuidMask()
Returns the filter set on the service Solicitation uuid mask. |
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 |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Fields
CREATOR
public static final Creator<ScanFilter> CREATOR
A Parcelable.Creator
to create ScanFilter
from parcel.
Public methods
describeContents
public 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(android.os.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.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
equals
public 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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
Parameters | |
---|---|
obj |
Object : This value may be null . |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getAdvertisingData
public byte[] getAdvertisingData ()
Returns the advertising data of this filter.
Returns | |
---|---|
byte[] |
This value may be null . |
getAdvertisingDataMask
public byte[] getAdvertisingDataMask ()
Returns the advertising data mask of this filter.
Returns | |
---|---|
byte[] |
This value may be null . |
getAdvertisingDataType
public int getAdvertisingDataType ()
Returns the advertising data type of this filter. Returns ScanRecord.DATA_TYPE_NONE
if the type is not set. The values of advertising data type are defined in the Bluetooth
Generic Access Profile (https://www.bluetooth.com/specifications/assigned-numbers/)
getDeviceAddress
public String getDeviceAddress ()
Returns | |
---|---|
String |
This value may be null . |
getDeviceName
public String getDeviceName ()
Returns the filter set the device name field of Bluetooth advertisement data.
Returns | |
---|---|
String |
This value may be null . |
getManufacturerData
public byte[] getManufacturerData ()
Returns | |
---|---|
byte[] |
This value may be null . |
getManufacturerDataMask
public byte[] getManufacturerDataMask ()
Returns | |
---|---|
byte[] |
This value may be null . |
getManufacturerId
public int getManufacturerId ()
Returns the manufacturer id. -1 if the manufacturer filter is not set.
Returns | |
---|---|
int |
getServiceData
public byte[] getServiceData ()
Returns | |
---|---|
byte[] |
This value may be null . |
getServiceDataMask
public byte[] getServiceDataMask ()
Returns | |
---|---|
byte[] |
This value may be null . |
getServiceDataUuid
public ParcelUuid getServiceDataUuid ()
Returns | |
---|---|
ParcelUuid |
This value may be null . |
getServiceSolicitationUuid
public ParcelUuid getServiceSolicitationUuid ()
Returns the filter set on the service Solicitation uuid.
Returns | |
---|---|
ParcelUuid |
This value may be null . |
getServiceSolicitationUuidMask
public ParcelUuid getServiceSolicitationUuidMask ()
Returns the filter set on the service Solicitation uuid mask.
Returns | |
---|---|
ParcelUuid |
This value may be null . |
getServiceUuid
public ParcelUuid getServiceUuid ()
Returns the filter set on the service uuid.
Returns | |
---|---|
ParcelUuid |
This value may be null . |
getServiceUuidMask
public ParcelUuid getServiceUuidMask ()
Returns | |
---|---|
ParcelUuid |
This value may be null . |
hashCode
public 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 inequals
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
method, then calling thehashCode
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
method, then calling thehashCode
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.
Returns | |
---|---|
int |
a hash code value for this object. |
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.
Parameters | |
---|---|
scanResult |
ScanResult |
Returns | |
---|---|
boolean |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the object. |
writeToParcel
public 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.
This value cannot be null . |
flags |
int : Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-12-18 UTC.