# BluetoothDeviceFilter.Builder

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Ctors](https://developer.android.com/reference/android/companion/BluetoothDeviceFilter.Builder#pubctors)\|[Methods](https://developer.android.com/reference/android/companion/BluetoothDeviceFilter.Builder#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/companion/BluetoothDeviceFilter.Builder#inhmethods)  

# BluetoothDeviceFilter.Builder

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/companion/BluetoothDeviceFilter.Builder "View this page in Kotlin")\|Java

`
public
static
final

class
BluetoothDeviceFilter.Builder
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


`

|---|-------------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.companion.BluetoothDeviceFilter.Builder |

<br />

*** ** * ** ***

A builder for[BluetoothDeviceFilter](https://developer.android.com/reference/android/companion/BluetoothDeviceFilter)

## Summary

|                                                 ### Public constructors                                                 ||
|----------------------------------------------------------------------------------------------------------------------|---|
| ` `[Builder](https://developer.android.com/reference/android/companion/BluetoothDeviceFilter.Builder#Builder())`() ` |

|                                                                                                                                                                                                                                                                                                                                                      ### Public methods                                                                                                                                                                                                                                                                                                                                                      ||
|-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` `[BluetoothDeviceFilter.Builder](https://developer.android.com/reference/android/companion/BluetoothDeviceFilter.Builder) | ` `[addServiceUuid](https://developer.android.com/reference/android/companion/BluetoothDeviceFilter.Builder#addServiceUuid(android.os.ParcelUuid,%20android.os.ParcelUuid))`(`[ParcelUuid](https://developer.android.com/reference/android/os/ParcelUuid)` serviceUuid, `[ParcelUuid](https://developer.android.com/reference/android/os/ParcelUuid)` serviceUuidMask) ` Add filtering by certain bits of[BluetoothDevice.getUuids()](https://developer.android.com/reference/android/bluetooth/BluetoothDevice#getUuids())A device with any uuid matching the given bits is considered passing |
| ` `[BluetoothDeviceFilter](https://developer.android.com/reference/android/companion/BluetoothDeviceFilter)                 | ` `[build](https://developer.android.com/reference/android/companion/BluetoothDeviceFilter.Builder#build())`() `                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| ` `[BluetoothDeviceFilter.Builder](https://developer.android.com/reference/android/companion/BluetoothDeviceFilter.Builder) | ` `[setAddress](https://developer.android.com/reference/android/companion/BluetoothDeviceFilter.Builder#setAddress(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` address) `                                                                                                                                                                                                                                                                                                                                                                          |
| ` `[BluetoothDeviceFilter.Builder](https://developer.android.com/reference/android/companion/BluetoothDeviceFilter.Builder) | ` `[setNamePattern](https://developer.android.com/reference/android/companion/BluetoothDeviceFilter.Builder#setNamePattern(java.util.regex.Pattern))`(`[Pattern](https://developer.android.com/reference/java/util/regex/Pattern)` regex) `                                                                                                                                                                                                                                                                                                                                                     |

| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.                                                          | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed.                   | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*.                                                                                             | ||

## Public constructors

### Builder

```
public Builder ()
```

<br />

<br />

## Public methods

### addServiceUuid

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public BluetoothDeviceFilter.Builder addServiceUuid (ParcelUuid serviceUuid, 
                ParcelUuid serviceUuidMask)
```

Add filtering by certain bits of[BluetoothDevice.getUuids()](https://developer.android.com/reference/android/bluetooth/BluetoothDevice#getUuids())A device with any uuid matching the given bits is considered passing

<br />

|                                                     Parameters                                                     ||
|-------------------|-------------------------------------------------------------------------------------------------|
| `serviceUuid`     | `ParcelUuid`: the values for the bits to match This value may be`null`. <br />                  |
| `serviceUuidMask` | `ParcelUuid`: if provided, only those bits would have to match. This value may be`null`. <br /> |

|                                                                           Returns                                                                            ||
|--------------------------------------------------------------------------------------------------------------------------|------------------------------------|
| [BluetoothDeviceFilter.Builder](https://developer.android.com/reference/android/companion/BluetoothDeviceFilter.Builder) | This value cannot be`null`. <br /> |

### build

```
public BluetoothDeviceFilter build ()
```

<br />

<br />

|                                                     Returns                                                      ||
|----------------------------------------------------------------------------------------------------------|--------|
| [BluetoothDeviceFilter](https://developer.android.com/reference/android/companion/BluetoothDeviceFilter) | <br /> |

### setAddress

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public BluetoothDeviceFilter.Builder setAddress (String address)
```

<br />

<br />

|                                                                   Parameters                                                                   ||
|-----------|-------------------------------------------------------------------------------------------------------------------------------------|
| `address` | `String`: if set, only devices with MAC address exactly matching the given one will pass the filter This value may be`null`. <br /> |

|                                                                           Returns                                                                            ||
|--------------------------------------------------------------------------------------------------------------------------|------------------------------------|
| [BluetoothDeviceFilter.Builder](https://developer.android.com/reference/android/companion/BluetoothDeviceFilter.Builder) | This value cannot be`null`. <br /> |

### setNamePattern

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public BluetoothDeviceFilter.Builder setNamePattern (Pattern regex)
```

<br />

<br />

|                                                                                                         Parameters                                                                                                          ||
|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `regex` | `Pattern`: if set, only devices with[name](https://developer.android.com/reference/android/bluetooth/BluetoothDevice#getName())matching the given regular expression will be shown This value may be`null`. <br /> |

|                                                             Returns                                                              ||
|--------------------------------------------------------------------------------------------------------------------------|--------|
| [BluetoothDeviceFilter.Builder](https://developer.android.com/reference/android/companion/BluetoothDeviceFilter.Builder) | <br /> |