# Toggle.Builder

Artifact: [androidx.car.app:app](https://developer.android.com/jetpack/androidx/releases/car-app) [View Source](https://cs.android.com/search?q=file:androidx/car/app/model/Toggle.java+class:androidx.car.app.model.Toggle.Builder) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.0.0)

*** ** * ** ***


```
public final class Toggle.Builder
```

<br />

*** ** * ** ***

A builder of `https://developer.android.com/reference/androidx/car/app/model/Toggle`.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/car/app/model/Toggle.Builder#Builder(androidx.car.app.model.Toggle.OnCheckedChangeListener)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/car/app/model/Toggle.OnCheckedChangeListener onCheckedChangeListener)` Returns a new instance of a `https://developer.android.com/reference/androidx/car/app/model/Toggle.Builder` with the given `https://developer.android.com/reference/androidx/car/app/model/Toggle.OnCheckedChangeListener`. |

| ### Public methods |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/car/app/model/Toggle` | `https://developer.android.com/reference/androidx/car/app/model/Toggle.Builder#build()()` Constructs the `https://developer.android.com/reference/androidx/car/app/model/Toggle` defined by this builder. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/car/app/model/Toggle.Builder` | `https://developer.android.com/reference/androidx/car/app/model/Toggle.Builder#setChecked(boolean)(boolean checked)` Sets the initial checked state for `https://developer.android.com/reference/androidx/car/app/model/Toggle`. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/car/app/model/Toggle.Builder` | `@https://developer.android.com/reference/androidx/car/app/annotations/RequiresCarApi(value = 5) https://developer.android.com/reference/androidx/car/app/model/Toggle.Builder#setEnabled(boolean)(boolean enabled)` Sets the initial enabled state for `https://developer.android.com/reference/androidx/car/app/model/Toggle`. |

## Public constructors

### Builder

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.0.0)

```
public Builder(@NonNull Toggle.OnCheckedChangeListener onCheckedChangeListener)
```

Returns a new instance of a `https://developer.android.com/reference/androidx/car/app/model/Toggle.Builder` with the given `https://developer.android.com/reference/androidx/car/app/model/Toggle.OnCheckedChangeListener`.

Note that the listener relates to UI events and will be executed on the main thread using `https://developer.android.com/reference/android/os/Looper.html#getMainLooper()`.

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/NullPointerException.html` | if `onCheckedChangeListener` is `null` |

## Public methods

### build

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.0.0)

```
public @NonNull Toggle build()
```

Constructs the `https://developer.android.com/reference/androidx/car/app/model/Toggle` defined by this builder.

### setChecked

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.0.0)

```
public @NonNull Toggle.Builder setChecked(boolean checked)
```

Sets the initial checked state for `https://developer.android.com/reference/androidx/car/app/model/Toggle`.

The default state of a `https://developer.android.com/reference/androidx/car/app/model/Toggle` is unchecked.

### setEnabled

Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.3.0)

```
@RequiresCarApi(value = 5)
public @NonNull Toggle.Builder setEnabled(boolean enabled)
```

Sets the initial enabled state for `https://developer.android.com/reference/androidx/car/app/model/Toggle`.

The default state of a `https://developer.android.com/reference/androidx/car/app/model/Toggle` is enabled.