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

# WifiDeviceFilter.Builder

*** ** * ** ***

` public static final class WifiDeviceFilter.Builder `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

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

<br />

*** ** * ** ***

A builder for `https://developer.android.com/reference/android/companion/WifiDeviceFilter`

## Summary

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

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/companion/WifiDeviceFilter` | ` https://developer.android.com/reference/android/companion/WifiDeviceFilter.Builder#build()() ` Builds the instance. |
| ` https://developer.android.com/reference/android/companion/WifiDeviceFilter.Builder` | ` https://developer.android.com/reference/android/companion/WifiDeviceFilter.Builder#setBssid(android.net.MacAddress)(https://developer.android.com/reference/android/net/MacAddress value) ` If set, only devices with BSSID matching the given one will be shown |
| ` https://developer.android.com/reference/android/companion/WifiDeviceFilter.Builder` | ` https://developer.android.com/reference/android/companion/WifiDeviceFilter.Builder#setBssidMask(android.net.MacAddress)(https://developer.android.com/reference/android/net/MacAddress value) ` If set, only bits at positions set in this mask, will be compared to the given `https://developer.android.com/reference/android/companion/WifiDeviceFilter.Builder#setBssid(android.net.MacAddress)` filter. |
| ` https://developer.android.com/reference/android/companion/WifiDeviceFilter.Builder` | ` https://developer.android.com/reference/android/companion/WifiDeviceFilter.Builder#setNamePattern(java.util.regex.Pattern)(https://developer.android.com/reference/java/util/regex/Pattern value) ` If set, only devices with `https://developer.android.com/reference/android/bluetooth/BluetoothDevice#getName()` matching the given regular expression will be shown |

### 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

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

```
public Builder ()
```

<br />

<br />

## Public methods

### build

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

```
public WifiDeviceFilter build ()
```

Builds the instance. This builder should not be touched after calling this!

<br />

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

### setBssid

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

```
public WifiDeviceFilter.Builder setBssid (MacAddress value)
```

If set, only devices with BSSID matching the given one will be shown

<br />

| Parameters ||
|---|---|
| `value` | `MacAddress`: This value cannot be `null`. <br /> |

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

### setBssidMask

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

```
public WifiDeviceFilter.Builder setBssidMask (MacAddress value)
```

If set, only bits at positions set in this mask, will be compared to the given `https://developer.android.com/reference/android/companion/WifiDeviceFilter.Builder#setBssid(android.net.MacAddress)` filter.

<br />

| Parameters ||
|---|---|
| `value` | `MacAddress`: This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/companion/WifiDeviceFilter.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 WifiDeviceFilter.Builder setNamePattern (Pattern value)
```

If set, only devices with `https://developer.android.com/reference/android/bluetooth/BluetoothDevice#getName()` matching the given regular expression will be shown

<br />

| Parameters ||
|---|---|
| `value` | `Pattern`: This value may be `null`. <br /> |

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