StepManeuver (services-directions-models API)

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

All Implemented Interfaces:

java.io.Serializable
```
public abstract class StepManeuver
extends DirectionsJsonObject
```
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`.
`static interface`	`StepManeuver.StepManeuverType` Maneuver types.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ARRIVE` Indicates arrival to a destination of a leg.
`static java.lang.String`	`CONTINUE` Continue on a street after a turn.
`static java.lang.String`	`DEPART` Indicates departure from a leg.
`static java.lang.String`	`END_OF_ROAD` Road ends in a T intersection.
`static java.lang.String`	`EXIT_ROTARY` Indicates the exit maneuver from a rotary.
`static java.lang.String`	`EXIT_ROUNDABOUT` Indicates the exit maneuver from a roundabout.
`static java.lang.String`	`FORK` Take the left or right side of a fork.
`static java.lang.String`	`MERGE` Merge onto a street.
`static java.lang.String`	`NEW_NAME` The road name changes (after a mandatory turn).
`static java.lang.String`	`NOTIFICATION` Indicates a change of driving conditions, for example changing the mode from driving to ferry.
`static java.lang.String`	`OFF_RAMP` Take a ramp to exit a highway.
`static java.lang.String`	`ON_RAMP` Take a ramp to enter a highway.
`static java.lang.String`	`ROTARY` A traffic circle.
`static java.lang.String`	`ROUNDABOUT` Traverse roundabout.
`static java.lang.String`	`ROUNDABOUT_TURN` A small roundabout that is treated as an intersection.
`static java.lang.String`	`TURN` A basic turn in the direction of the modifier.

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.
`static StepManeuver`	`fromJson(java.lang.String json)` Create a new instance of this class by passing in a formatted valid JSON String.
`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 com.mapbox.api.directions.v5.models.DirectionsJsonObject
getUnrecognizedJsonProperties, getUnrecognizedPropertiesNames, getUnrecognizedProperty, toJson

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

- Field Detail
  - TURN
```
public static final java.lang.String TURN
```
    A basic turn in the direction of the modifier.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - NEW_NAME
```
public static final java.lang.String NEW_NAME
```
    The road name changes (after a mandatory turn).
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - DEPART
```
public static final java.lang.String DEPART
```
    Indicates departure from a leg. The modifier value indicates the position of the departure point in relation to the current direction of travel.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - ARRIVE
```
public static final java.lang.String ARRIVE
```
    Indicates arrival to a destination of a leg. The modifier value indicates the position of the arrival point in relation to the current direction of travel.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - MERGE
```
public static final java.lang.String MERGE
```
    Merge onto a street.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - ON_RAMP
```
public static final java.lang.String ON_RAMP
```
    Take a ramp to enter a highway.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - OFF_RAMP
```
public static final java.lang.String OFF_RAMP
```
    Take a ramp to exit a highway.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - FORK
```
public static final java.lang.String FORK
```
    Take the left or right side of a fork.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - END_OF_ROAD
```
public static final java.lang.String END_OF_ROAD
```
    Road ends in a T intersection.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - CONTINUE
```
public static final java.lang.String CONTINUE
```
    Continue on a street after a turn.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - ROUNDABOUT
```
public static final java.lang.String ROUNDABOUT
```
    Traverse roundabout. Has an additional property exit in the route step that contains the exit number. The modifier specifies the direction of entering the roundabout.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - ROTARY
```
public static final java.lang.String 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() parameters, LegStep.rotaryPronunciation() ()} parameters, or both, in addition to the exit() property.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - ROUNDABOUT_TURN
```
public static final java.lang.String ROUNDABOUT_TURN
```
    A small roundabout that is treated as an intersection.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - NOTIFICATION
```
public static final java.lang.String NOTIFICATION
```
    Indicates a change of driving conditions, for example changing the mode from driving to ferry.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - EXIT_ROUNDABOUT
```
public static final java.lang.String EXIT_ROUNDABOUT
```
    Indicates the exit maneuver from a roundabout. Will not appear in results unless you supply true to the exit() query parameter in the request.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
  - EXIT_ROTARY
```
public static final java.lang.String EXIT_ROTARY
```
    Indicates the exit maneuver from a rotary. Will not appear in results unless you supply true to the MapboxDirections.Builder#roundaboutExits() query parameter in the request.
    
    Since:
    
    4.1.0
    
    See Also:
    
    Constant Field Values
- 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.
    
    Returns:
    
    String with type of maneuver
    
    Since:
    
    1.0.0
    
    See Also:
    
    StepManeuver.StepManeuverType
  - 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
  - fromJson
```
public static StepManeuver fromJson(java.lang.String json)
```
    Create a new instance of this class by passing in a formatted valid JSON String.
    
    Parameters:
    
    json - a formatted valid JSON string defining a StepManeuver
    
    Returns:
    
    a new instance of this class defined by the values passed inside this static factory method
    
    Since:
    
    3.4.0

Class StepManeuver

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.mapbox.api.directions.v5.models.DirectionsJsonObject

Methods inherited from class java.lang.Object

Field Detail

TURN

NEW_NAME

DEPART

ARRIVE

MERGE

ON_RAMP

OFF_RAMP

FORK

END_OF_ROAD

CONTINUE

ROUNDABOUT

ROTARY

ROUNDABOUT_TURN

NOTIFICATION

EXIT_ROUNDABOUT

EXIT_ROTARY

Constructor Detail

StepManeuver

Method Detail

builder

location

rawLocation

bearingBefore

bearingAfter

instruction

type

modifier

exit

toBuilder

typeAdapter

fromJson