# Header

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/Header.java+class:androidx.car.app.model.Header) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/car-app#1.2.0)

*** ** * ** ***


```
@RequiresCarApi(value = 5)
@CarProtocol
public final class Header
```

<br />

*** ** * ** ***

A component that holds onto data associated with a template's header.

## Summary

| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/androidx/car/app/model/Header.Builder` A builder of `https://developer.android.com/reference/androidx/car/app/model/Header`. |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/car/app/model/Header#equals(java.lang.Object)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/Object.html other)` |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/car/app/model/Background` | `@https://developer.android.com/reference/androidx/car/app/annotations/ExperimentalCarApi @https://developer.android.com/reference/androidx/car/app/annotations/RequiresCarApi(value = 9) https://developer.android.com/reference/androidx/car/app/model/Header#getBackground()()` Returns the `https://developer.android.com/reference/androidx/car/app/model/Background` of the component or `null` if not set. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/androidx/car/app/model/Action>` | `https://developer.android.com/reference/androidx/car/app/model/Header#getEndHeaderActions()()` Returns the `https://developer.android.com/reference/androidx/car/app/model/Action`s that are set to be displayed at the end of the header, or `null` if not set. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/car/app/model/Action` | `https://developer.android.com/reference/androidx/car/app/model/Header#getStartHeaderAction()()` Returns the `https://developer.android.com/reference/androidx/car/app/model/Action` that is set to be displayed at the start of the header, or `null` if not set. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/car/app/model/CarIcon` | `@https://developer.android.com/reference/androidx/car/app/annotations/ExperimentalCarApi @https://developer.android.com/reference/androidx/car/app/annotations/RequiresCarApi(value = 9) https://developer.android.com/reference/androidx/car/app/model/Header#getStartHeaderImage()()` Returns the start image of the component or `null` if not set. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/car/app/model/CarText` | `@https://developer.android.com/reference/androidx/car/app/annotations/ExperimentalCarApi @https://developer.android.com/reference/androidx/car/app/annotations/RequiresCarApi(value = 9) https://developer.android.com/reference/androidx/car/app/model/Header#getSubtitle()()` Returns the subtitle of the component or `null` if not set. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/car/app/model/CarText` | `https://developer.android.com/reference/androidx/car/app/model/Header#getTitle()()` Returns the title of the component or `null` if not set. |
| `int` | `https://developer.android.com/reference/androidx/car/app/model/Header#hashCode()()` |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/car/app/model/Header#toString()()` |

## Public methods

### equals

```
public boolean equals(@Nullable Object other)
```

### getBackground

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

```
@ExperimentalCarApi
@RequiresCarApi(value = 9)
public @Nullable Background getBackground()
```

Returns the `https://developer.android.com/reference/androidx/car/app/model/Background` of the component or `null` if not set.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/car/app/model/Header.Builder#setBackground(androidx.car.app.model.Background)` |   |

### getEndHeaderActions

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

```
public @NonNull List<Action> getEndHeaderActions()
```

Returns the `https://developer.android.com/reference/androidx/car/app/model/Action`s that are set to be displayed at the end of the header, or `null` if not set.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/car/app/model/Header.Builder#addEndHeaderAction(androidx.car.app.model.Action)` |   |

### getStartHeaderAction

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

```
public @Nullable Action getStartHeaderAction()
```

Returns the `https://developer.android.com/reference/androidx/car/app/model/Action` that is set to be displayed at the start of the header, or `null` if not set.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/car/app/model/Header.Builder#setStartHeaderAction(androidx.car.app.model.Action)` |   |

### getStartHeaderImage

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

```
@ExperimentalCarApi
@RequiresCarApi(value = 9)
public @Nullable CarIcon getStartHeaderImage()
```

Returns the start image of the component or `null` if not set.

### getSubtitle

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

```
@ExperimentalCarApi
@RequiresCarApi(value = 9)
public @Nullable CarText getSubtitle()
```

Returns the subtitle of the component or `null` if not set.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/car/app/model/Header.Builder#setSubtitle(java.lang.CharSequence)` |   |

### getTitle

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

```
public @Nullable CarText getTitle()
```

Returns the title of the component or `null` if not set.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/car/app/model/Header.Builder#setTitle(java.lang.CharSequence)` |   |

### hashCode

```
public int hashCode()
```

### toString

```
public @NonNull String toString()
```