# Step

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

*** ** * ** ***


```
@CarProtocol
public final class Step
```

<br />

*** ** * ** ***

Represents a step that the driver should take in order to remain on the current navigation route.

Example of steps are turning onto a street, taking a highway exit and merging onto a different highway, or continuing straight through a roundabout.

## Summary

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

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/car/app/navigation/model/Step#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/CarText` | `https://developer.android.com/reference/androidx/car/app/navigation/model/Step#getCue()()` Returns the text description of this maneuver 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/navigation/model/Lane>` | `https://developer.android.com/reference/androidx/car/app/navigation/model/Step#getLanes()()` Returns a list of `https://developer.android.com/reference/androidx/car/app/navigation/model/Lane` that contains information of the road lanes at the point where the driver should execute this step. |
| `@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/navigation/model/Step#getLanesImage()()` Returns the image representing all the lanes or `null` if not set. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/car/app/navigation/model/Maneuver` | `https://developer.android.com/reference/androidx/car/app/navigation/model/Step#getManeuver()()` Returns the maneuver to be performed on this step or `null` if this step doesn't involve a maneuver. |
| `@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/navigation/model/Step#getRoad()()` Returns the text description of the road for the step or `null` if unknown. |
| `int` | `https://developer.android.com/reference/androidx/car/app/navigation/model/Step#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/navigation/model/Step#toString()()` |

## Public methods

### equals

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

### getCue

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

```
public @Nullable CarText getCue()
```

Returns the text description of this maneuver or `null` if not set.

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

### getLanes

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

```
public @NonNull List<Lane> getLanes()
```

Returns a list of `https://developer.android.com/reference/androidx/car/app/navigation/model/Lane` that contains information of the road lanes at the point where the driver should execute this step.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/car/app/navigation/model/Step.Builder#addLane(androidx.car.app.navigation.model.Lane)` |   |

### getLanesImage

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

```
public @Nullable CarIcon getLanesImage()
```

Returns the image representing all the lanes or `null` if not set.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/car/app/navigation/model/Step.Builder#setLanesImage(androidx.car.app.model.CarIcon)` |   |

### getManeuver

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

```
public @Nullable Maneuver getManeuver()
```

Returns the maneuver to be performed on this step or `null` if this step doesn't involve a maneuver.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/car/app/navigation/model/Step.Builder#setManeuver(androidx.car.app.navigation.model.Maneuver)` |   |

### getRoad

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

```
public @Nullable CarText getRoad()
```

Returns the text description of the road for the step or `null` if unknown.

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

### hashCode

```
public int hashCode()
```

### toString

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