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/BluetoothLeDeviceFilter.Builder#pubctors) \| [Methods](https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter.Builder#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter.Builder#inhmethods)

# BluetoothLeDeviceFilter.Builder

*** ** * ** ***

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


`
public
static
final

class
BluetoothLeDeviceFilter.Builder
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


`

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

<br />

*** ** * ** ***

Builder for `https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter`

## Summary

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

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter` | ` https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter.Builder#build()() ` |
| ` https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter.Builder` | ` https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter.Builder#setNamePattern(java.util.regex.Pattern)(https://developer.android.com/reference/java/util/regex/Pattern regex) ` |
| ` https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter.Builder` | ` https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter.Builder#setRawDataFilter(byte[],%20byte[])(byte[] rawDataFilter, byte[] rawDataFilterMask) ` Filter devices by raw advertisement data, as obtained by `https://developer.android.com/reference/android/bluetooth/le/ScanRecord#getBytes()` |
| ` https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter.Builder` | ` https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter.Builder#setRenameFromBytes(java.lang.String,%20java.lang.String,%20int,%20int,%20java.nio.ByteOrder)(https://developer.android.com/reference/java/lang/String prefix, https://developer.android.com/reference/java/lang/String suffix, int bytesFrom, int bytesLength, https://developer.android.com/reference/java/nio/ByteOrder byteOrder) ` Rename the devices shown in the list, using specific bytes from the raw advertisement data (`https://developer.android.com/reference/android/bluetooth/le/ScanRecord#getBytes()`) in hexadecimal format, as well as a custom prefix/suffix around them Note that the prefix length is limited to `https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter#getRenamePrefixLengthLimit()` characters to ensure that there's enough space to display the byte data The range of bytes to be displayed cannot be empty |
| ` https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter.Builder` | ` https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter.Builder#setRenameFromName(java.lang.String,%20java.lang.String,%20int,%20int)(https://developer.android.com/reference/java/lang/String prefix, https://developer.android.com/reference/java/lang/String suffix, int nameFrom, int nameLength) ` Rename the devices shown in the list, using specific characters from the advertised name, as well as a custom prefix/suffix around them Note that the prefix length is limited to `https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter#getRenamePrefixLengthLimit()` characters to ensure that there's enough space to display the byte data The range of name characters to be displayed cannot be empty |
| ` https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter.Builder` | ` https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter.Builder#setScanFilter(android.bluetooth.le.ScanFilter)(https://developer.android.com/reference/android/bluetooth/le/ScanFilter scanFilter) ` |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` 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 https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` 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` | ` 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` | ` 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

### build

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

```
public BluetoothLeDeviceFilter build ()
```

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter` | This value cannot be `null`. <br /> |

### setNamePattern

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

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

<br />

<br />

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

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter.Builder` | self for chaining <br /> |

### setRawDataFilter

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

```
public BluetoothLeDeviceFilter.Builder setRawDataFilter (byte[] rawDataFilter, 
                byte[] rawDataFilterMask)
```

Filter devices by raw advertisement data, as obtained by `https://developer.android.com/reference/android/bluetooth/le/ScanRecord#getBytes()`

<br />

| Parameters ||
|---|---|
| `rawDataFilter` | `byte`: bit values that have to match against advertized data. This value cannot be `null`. <br /> |
| `rawDataFilterMask` | `byte`: bits that have to be matched. This value may be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter.Builder` | self for chaining. This value cannot be `null`. <br /> |

### setRenameFromBytes

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

```
public BluetoothLeDeviceFilter.Builder setRenameFromBytes (String prefix, 
                String suffix, 
                int bytesFrom, 
                int bytesLength, 
                ByteOrder byteOrder)
```

Rename the devices shown in the list, using specific bytes from the raw advertisement
data (`https://developer.android.com/reference/android/bluetooth/le/ScanRecord#getBytes()`) in hexadecimal format, as well as a custom
prefix/suffix around them

Note that the prefix length is limited to `https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter#getRenamePrefixLengthLimit()` characters
to ensure that there's enough space to display the byte data

The range of bytes to be displayed cannot be empty

<br />

| Parameters ||
|---|---|
| `prefix` | `String`: to be displayed before the byte data. This value cannot be `null`. <br /> |
| `suffix` | `String`: to be displayed after the byte data. This value cannot be `null`. <br /> |
| `bytesFrom` | `int`: the start byte index to be displayed (inclusive) <br /> |
| `bytesLength` | `int`: the number of bytes to be displayed from the given index <br /> |
| `byteOrder` | `ByteOrder`: whether the given range of bytes is big endian (will be displayed in same order) or little endian (will be flipped before displaying) <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter.Builder` | self for chaining. This value cannot be `null`. <br /> |

### setRenameFromName

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

```
public BluetoothLeDeviceFilter.Builder setRenameFromName (String prefix, 
                String suffix, 
                int nameFrom, 
                int nameLength)
```

Rename the devices shown in the list, using specific characters from the advertised name,
as well as a custom prefix/suffix around them

Note that the prefix length is limited to `https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter#getRenamePrefixLengthLimit()` characters
to ensure that there's enough space to display the byte data

The range of name characters to be displayed cannot be empty

<br />

| Parameters ||
|---|---|
| `prefix` | `String`: to be displayed before the byte data. This value cannot be `null`. <br /> |
| `suffix` | `String`: to be displayed after the byte data. This value cannot be `null`. <br /> |
| `nameFrom` | `int`: the start name character index to be displayed (inclusive) <br /> |
| `nameLength` | `int`: the number of characters to be displayed from the given index <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter.Builder` | self for chaining. This value cannot be `null`. <br /> |

### setScanFilter

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

```
public BluetoothLeDeviceFilter.Builder setScanFilter (ScanFilter scanFilter)
```

<br />

<br />

| Parameters ||
|---|---|
| `scanFilter` | `ScanFilter`: a `https://developer.android.com/reference/android/bluetooth/le/ScanFilter` to filter devices by. This value may be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/companion/BluetoothLeDeviceFilter.Builder` | self for chaining. This value cannot be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/bluetooth/le/ScanFilter`