StepManeuver (services 3.2.0 API)

java.lang.Object
- com.mapbox.api.directions.v5.models.StepManeuver

All Implemented Interfaces:

java.io.Serializable
```
public abstract class StepManeuver
extends java.lang.Object
implements java.io.Serializable
```
Gives maneuver information about one LegStep.

Since:

1.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class StepManeuver.Builder
This builder can be used to set the values describing the StepManeuver.

Nested Classes
Modifier and Type	Class and Description
`static class`	`StepManeuver.Builder` This builder can be used to set the values describing the `StepManeuver`.

Constructor Summary

Constructors
Constructor and Description

StepManeuver()

Constructors
Constructor and Description
`StepManeuver()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract java.lang.Double`	`bearingAfter()` Number between 0 and 360 indicating the clockwise angle from true north to the direction of travel right after the maneuver.
`abstract java.lang.Double`	`bearingBefore()` Number between 0 and 360 indicating the clockwise angle from true north to the direction of travel right before the maneuver.
`static StepManeuver.Builder`	`builder()` Create a new instance of this class by using the `StepManeuver.Builder` class.
`abstract java.lang.Integer`	`exit()` An optional integer indicating number of the exit to take.
`abstract java.lang.String`	`instruction()` A human-readable instruction of how to execute the returned maneuver.
`com.mapbox.geojson.Point`	`location()` A `Point` representing this intersection location.
`abstract java.lang.String`	`modifier()` This indicates the mode of the maneuver.
`protected abstract double[]`	`rawLocation()` A `Point` representing this intersection location.
`abstract StepManeuver.Builder`	`toBuilder()` Convert the current `StepManeuver` to its builder holding the currently assigned values.
`abstract java.lang.String`	`type()` This indicates the type of maneuver.
`static com.google.gson.TypeAdapter<StepManeuver>`	`typeAdapter(com.google.gson.Gson gson)` Gson type adapter for parsing Gson to this class.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StepManeuver
```
public StepManeuver()
```
- Method Detail
  - builder
```
public static StepManeuver.Builder builder()
```
    Create a new instance of this class by using the StepManeuver.Builder class.
    
    Returns:
    
    this classes StepManeuver.Builder for creating a new instance
    
    Since:
    
    3.0.0
  - location
```
@NonNull
public com.mapbox.geojson.Point location()
```
    A Point representing this intersection location.
    
    Returns:
    
    GeoJson Point representing this intersection location
    
    Since:
    
    3.0.0
  - rawLocation
```
@NonNull
 @SerializedName(value="location")
protected abstract double[] rawLocation()
```
    A Point representing this intersection location. Since the rawLocation isn't public, it's okay to be mutable as long as nothing in this SDK changes values.
    
    Returns:
    
    GeoJson Point representing this intersection location
    
    Since:
    
    3.0.0
  - bearingBefore
```
@Nullable
 @SerializedName(value="bearing_before")
public abstract java.lang.Double bearingBefore()
```
    Number between 0 and 360 indicating the clockwise angle from true north to the direction of travel right before the maneuver.
    
    Returns:
    
    double with value from 0 to 360
    
    Since:
    
    1.0.0
  - bearingAfter
```
@Nullable
 @SerializedName(value="bearing_after")
public abstract java.lang.Double bearingAfter()
```
    Number between 0 and 360 indicating the clockwise angle from true north to the direction of travel right after the maneuver.
    
    Returns:
    
    double with value from 0 to 360
    
    Since:
    
    1.0.0
  - instruction
```
@Nullable
public abstract java.lang.String instruction()
```
    A human-readable instruction of how to execute the returned maneuver. This String is built using OSRM-Text-Instructions and can be further customized inside either the Mapbox Navigation SDK for Android or using the OSRM-Text-Instructions.java project in Project-OSRM.
    
    Returns:
    
    String with instruction
    
    Since:
    
    1.0.0
    
    See Also:
    
    Navigation SDK, OSRM-Text-Instructions.java
  - type
```
@Nullable
public abstract java.lang.String type()
```
    This indicates the type of maneuver. It can be any of these listed:
    - turn - a basic turn into direction of the modifier
    - new name - the road name changes (after a mandatory turn)
    - depart - indicates departure from a leg
    - arrive - indicates arrival to a destination of a leg
    - merge - merge onto a street
    - on ramp - take a ramp to enter a highway
    - off ramp - take a ramp to exit a highway
    - fork - take the left/right side of a fork
    - end of road - road ends in a T intersection
    - continue - continue on a street after a turn
    - roundabout - traverse roundabout, has additional property exit() in RouteStep containing the exit number. The modifier specifies the direction of entering the roundabout.
    - rotary - a traffic circle. While very similar to a larger version of a roundabout, it does not necessarily follow roundabout rules for right of way. It can offer LegStep.rotaryName() and/or LegStep.rotaryPronunciation() parameters in addition to the exit() property.
    - roundabout turn - small roundabout that is treated as an intersection
    - notification - change of driving conditions, e.g. change of mode from driving to ferry
    Returns:
    
    String with type of maneuver
    
    Since:
    
    1.0.0
  - modifier
```
@Nullable
public abstract java.lang.String modifier()
```
    This indicates the mode of the maneuver. If type is of turn, the modifier indicates the change in direction accomplished through the turn. If the type is of depart/arrive, the modifier indicates the position of waypoint from the current direction of travel.
    
    Returns:
    
    String with modifier
    
    Since:
    
    1.0.0
  - exit
```
@Nullable
public abstract java.lang.Integer exit()
```
    An optional integer indicating number of the exit to take. If exit is undefined the destination is on the roundabout. The property exists for the following type properties:
    else - indicates the number of intersections passed until the turn. roundabout - traverse roundabout rotary - a traffic circle
    
    Returns:
    
    an integer indicating number of the exit to take
    
    Since:
    
    2.0.0
  - toBuilder
```
public abstract StepManeuver.Builder toBuilder()
```
    Convert the current StepManeuver to its builder holding the currently assigned values. This allows you to modify a single property and then rebuild the object resulting in an updated and modified StepManeuver.
    
    Returns:
    
    a StepManeuver.Builder with the same values set to match the ones defined in this StepManeuver
    
    Since:
    
    3.1.0
  - typeAdapter
```
public static com.google.gson.TypeAdapter<StepManeuver> typeAdapter(com.google.gson.Gson gson)
```
    Gson type adapter for parsing Gson to this class.
    
    Parameters:
    
    gson - the built Gson object
    
    Returns:
    
    the type adapter for this class
    
    Since:
    
    3.0.0

Class StepManeuver

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StepManeuver

Method Detail

builder

location

rawLocation

bearingBefore

bearingAfter

instruction

type

modifier

exit

toBuilder

typeAdapter