com.mapbox.api.directions.v5.models

Class StepManeuver.Builder

java.lang.Object

com.mapbox.api.directions.v5.models.StepManeuver.Builder

Enclosing class:

StepManeuver

public abstract static class StepManeuver.Builder
extends java.lang.Object

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

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract StepManeuver.Builder	bearingAfter(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 StepManeuver.Builder	bearingBefore(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.
abstract StepManeuver	build() Build a new StepManeuver object.
abstract StepManeuver.Builder	exit(java.lang.Integer exit) An optional integer indicating number of the exit to take.
abstract StepManeuver.Builder	instruction(java.lang.String instruction) A human-readable instruction of how to execute the returned maneuver.
abstract StepManeuver.Builder	modifier(java.lang.String modifier) This indicates the mode of the maneuver.
abstract StepManeuver.Builder	rawLocation(double[] rawLocation) The rawLocation as a double array.
abstract StepManeuver.Builder	type(java.lang.String type) This indicates the type of maneuver.
T	unrecognizedJsonProperties(java.util.Map<java.lang.String,com.google.gson.JsonElement> unrecognizedProperties) Use this method to add parameters which are not present in the model yet but are supported on the Directions API side in the response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

rawLocation

public abstract StepManeuver.Builder rawLocation(@NonNull
                                                 double[] rawLocation)

The rawLocation as a double array. Once the StepManeuver object's created, this raw location gets converted into a Point object and is public exposed as such. The double array should have a length of two, index 0 being the longitude and index 1 being latitude.

Parameters:

rawLocation - a double array with a length of two, index 0 being the longitude and index 1 being latitude.

Returns:

this builder for chaining options together

Since:

3.0.0

bearingBefore

public abstract StepManeuver.Builder bearingBefore(@Nullable
                                                   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.

Parameters:

bearingBefore - double with value from 0 to 360

Returns:

this builder for chaining options together

Since:

3.0.0

bearingAfter

public abstract StepManeuver.Builder bearingAfter(@Nullable
                                                  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.

Parameters:

bearingAfter - double with value from 0 to 360

Returns:

this builder for chaining options together

Since:

3.0.0

instruction

public abstract StepManeuver.Builder instruction(@Nullable
                                                 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.

Parameters:

instruction - String with instruction

Returns:

this builder for chaining options together

Since:

3.0.0

See Also:

Navigation SDK, OSRM-Text-Instructions.java

type

public abstract StepManeuver.Builder type(@Nullable
                                          java.lang.String type)

This indicates the type of maneuver. See StepManeuver.type() for a full list of options.

Parameters:

type - String with type of maneuver

Returns:

this builder for chaining options together

Since:

3.0.0

See Also:

StepManeuver.StepManeuverType

modifier

public abstract StepManeuver.Builder modifier(@Nullable
                                              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.

Parameters:

modifier - String with modifier

Returns:

this builder for chaining options together

Since:

3.0.0

exit

public abstract StepManeuver.Builder exit(@Nullable
                                          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

Parameters:

exit - an integer indicating number of the exit to take

Returns:

this builder for chaining options together

Since:

2.0.0

build

public abstract StepManeuver build()

Build a new StepManeuver object.

Returns:

a new StepManeuver using the provided values in this builder

Since:

3.0.0

unrecognizedJsonProperties

@NonNull
public T unrecognizedJsonProperties(@Nullable
                                             java.util.Map<java.lang.String,com.google.gson.JsonElement> unrecognizedProperties)

Use this method to add parameters which are not present in the model yet but are supported on the Directions API side in the response. Use it for experimental parameters.

Parameters:

unrecognizedProperties - parameters to add to request