LegStep.Builder (services 4.2.0-SNAPSHOT API)

java.lang.Object
- com.mapbox.api.directions.v5.models.LegStep.Builder

Enclosing class:

LegStep
```
public abstract static class LegStep.Builder
extends java.lang.Object
```
This builder can be used to set the values describing the LegStep.

Since:

3.0.0

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`abstract LegStep.Builder`	`bannerInstructions(java.util.List<BannerInstructions> bannerInstructions)` If in your request you set `MapboxDirections.bannerInstructions()` to true, you'll receive a list of `BannerInstructions` which encompasses all information necessary for creating a visual cue about a given `LegStep`.
`abstract LegStep`	`build()` Build a new `LegStep` object.
`abstract LegStep.Builder`	`destinations(java.lang.String destinations)` String with the destinations of the way along which the travel proceeds.
`abstract LegStep.Builder`	`distance(double distance)` The distance traveled from the maneuver to the next `LegStep`.
`abstract LegStep.Builder`	`drivingSide(java.lang.String drivingSide)` The legal driving side at the location for this step.
`abstract LegStep.Builder`	`duration(double duration)` The estimated travel time from the maneuver to the next `LegStep`.
`abstract LegStep.Builder`	`exits(java.lang.String exits)` String with the exit numbers or names of the way.
`abstract LegStep.Builder`	`geometry(java.lang.String geometry)` Gives the geometry of the leg step.
`abstract LegStep.Builder`	`intersections(java.util.List<StepIntersection> intersections)` Provide a list of all the intersections connected to the current way the user is traveling along.
`abstract LegStep.Builder`	`maneuver(StepManeuver maneuver)` A `StepManeuver` object that typically represents the first coordinate making up the `LegStep.geometry()`.
`abstract LegStep.Builder`	`mode(java.lang.String mode)` Indicates the mode of transportation in the step.
`abstract LegStep.Builder`	`name(java.lang.String name)` String with the name of the way along which the travel proceeds.
`abstract LegStep.Builder`	`pronunciation(java.lang.String pronunciation)` The pronunciation hint of the way name.
`abstract LegStep.Builder`	`ref(java.lang.String ref)` String with reference number or code of the way along which the travel proceeds.
`abstract LegStep.Builder`	`rotaryName(java.lang.String rotaryName)` An optional string indicating the name of the rotary.
`abstract LegStep.Builder`	`rotaryPronunciation(java.lang.String rotaryPronunciation)` An optional string indicating the pronunciation of the name of the rotary.
`abstract LegStep.Builder`	`voiceInstructions(java.util.List<VoiceInstructions> voiceInstructions)` The voice instructions object is useful for navigation sessions providing well spoken text instructions along with the distance from the maneuver the instructions should be said.
`abstract LegStep.Builder`	`weight(double weight)` Specifies a decimal precision of edge weights, default value 1.

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
  - distance
```
public abstract LegStep.Builder distance(double distance)
```
    The distance traveled from the maneuver to the next LegStep.
    
    Parameters:
    
    distance - a double number with unit meters
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - duration
```
public abstract LegStep.Builder duration(double duration)
```
    The estimated travel time from the maneuver to the next LegStep.
    
    Parameters:
    
    duration - a double number with unit seconds
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - geometry
```
public abstract LegStep.Builder geometry(@Nullable
                                         java.lang.String geometry)
```
    Gives the geometry of the leg step.
    
    Parameters:
    
    geometry - an encoded polyline string
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - name
```
public abstract LegStep.Builder name(@Nullable
                                     java.lang.String name)
```
    String with the name of the way along which the travel proceeds.
    
    Parameters:
    
    name - a String representing the way along which the travel proceeds
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - ref
```
public abstract LegStep.Builder ref(@Nullable
                                    java.lang.String ref)
```
    String with reference number or code of the way along which the travel proceeds.
    
    Parameters:
    
    ref - String with reference number or code of the way along which the travel proceeds. Optionally included, if data is available
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - destinations
```
public abstract LegStep.Builder destinations(@Nullable
                                             java.lang.String destinations)
```
    String with the destinations of the way along which the travel proceeds.
    
    Parameters:
    
    destinations - String with the destinations of the way along which the travel proceeds. Optionally included, if data is available
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - mode
```
public abstract LegStep.Builder mode(@NonNull
                                     java.lang.String mode)
```
    Indicates the mode of transportation in the step.
    
    Parameters:
    
    mode - String indicating the mode of transportation
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - pronunciation
```
public abstract LegStep.Builder pronunciation(@Nullable
                                              java.lang.String pronunciation)
```
    The pronunciation hint of the way name. Will be undefined if no pronunciation is hit.
    
    Parameters:
    
    pronunciation - String with the pronunciation
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - rotaryName
```
public abstract LegStep.Builder rotaryName(@Nullable
                                           java.lang.String rotaryName)
```
    An optional string indicating the name of the rotary. This will only be a nonnull when the maneuver type equals rotary.
    
    Parameters:
    
    rotaryName - String with the rotary name
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - rotaryPronunciation
```
public abstract LegStep.Builder rotaryPronunciation(@Nullable
                                                    java.lang.String rotaryPronunciation)
```
    An optional string indicating the pronunciation of the name of the rotary. This will only be a nonnull when the maneuver type equals rotary.
    
    Parameters:
    
    rotaryPronunciation - String in IPA with the rotary name's pronunciation.
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - maneuver
```
public abstract LegStep.Builder maneuver(@NonNull
                                         StepManeuver maneuver)
```
    A StepManeuver object that typically represents the first coordinate making up the LegStep.geometry().
    
    Parameters:
    
    maneuver - new StepManeuver object
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - voiceInstructions
```
public abstract LegStep.Builder voiceInstructions(@NonNull
                                                  java.util.List<VoiceInstructions> voiceInstructions)
```
    The voice instructions object is useful for navigation sessions providing well spoken text instructions along with the distance from the maneuver the instructions should be said.
    
    Parameters:
    
    voiceInstructions - a list of voice instructions which can be triggered on this current step
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - bannerInstructions
```
public abstract LegStep.Builder bannerInstructions(@NonNull
                                                   java.util.List<BannerInstructions> bannerInstructions)
```
    If in your request you set MapboxDirections.bannerInstructions() to true, you'll receive a list of BannerInstructions which encompasses all information necessary for creating a visual cue about a given LegStep.
    
    Parameters:
    
    bannerInstructions - a list of BannerInstructionss which help display visual cues inside your application
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - drivingSide
```
public abstract LegStep.Builder drivingSide(@Nullable
                                            java.lang.String drivingSide)
```
    The legal driving side at the location for this step. Result will either be left or right.
    
    Parameters:
    
    drivingSide - a string with either a left or right value
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - weight
```
public abstract LegStep.Builder weight(double weight)
```
    Specifies a decimal precision of edge weights, default value 1.
    
    Parameters:
    
    weight - a decimal precision double value
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.1.0
  - intersections
```
public abstract LegStep.Builder intersections(@NonNull
                                              java.util.List<StepIntersection> intersections)
```
    Provide a list of all the intersections connected to the current way the user is traveling along.
    
    Parameters:
    
    intersections - list of StepIntersection representing all intersections along the step
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - exits
```
public abstract LegStep.Builder exits(@Nullable
                                      java.lang.String exits)
```
    String with the exit numbers or names of the way. Optionally included, if data is available.
    
    Parameters:
    
    exits - a String identifying the exit number or name
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - build
```
public abstract LegStep build()
```
    Build a new LegStep object.
    
    Returns:
    
    a new LegStep using the provided values in this builder
    
    Since:
    
    3.0.0

Class LegStep.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

distance

duration

geometry

name

ref

destinations

mode

pronunciation

rotaryName

rotaryPronunciation

maneuver

voiceInstructions

bannerInstructions

drivingSide

weight

intersections

exits

build