com.nbmap.api.directions.v5.models

Class LegStep

java.lang.Object

com.nbmap.api.directions.v5.models.DirectionsJsonObject

com.nbmap.api.directions.v5.models.LegStep

All Implemented Interfaces:

java.io.Serializable

public abstract class LegStep
extends DirectionsJsonObject

Includes one StepManeuver object and travel to the following LegStep.

Since:

1.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LegStep.Builder This builder can be used to set the values describing the LegStep.
static interface	LegStep.SpeedLimitSign Speed limit sign.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MUTCD LegStep.SpeedLimitSign accident.
static java.lang.String	VIENNA LegStep.SpeedLimitSign congestion.

Constructor Summary

Constructors

Constructor and Description
LegStep()

Method Summary

Modifier and Type	Method and Description
abstract java.util.List<BannerInstructions>	bannerInstructions() If in your request you set NbmapDirections.Builder#bannerInstructions() to true, you'll receive a list of BannerInstructions which encompasses all information necessary for creating a visual cue about a given LegStep.
static LegStep.Builder	builder() Create a new instance of this class by using the LegStep.Builder class.
abstract java.lang.String	destinations() String with the destinations of the way along which the travel proceeds.
abstract double	distance() The distance traveled from the maneuver to the next LegStep.
abstract java.lang.String	drivingSide() The legal driving side at the location for this step.
abstract double	duration() The estimated travel time from the maneuver to the next LegStep.
abstract java.lang.Double	durationTypical() The typical travel time for traversing this LegStep.
abstract java.lang.String	exits() String with the exit numbers or names of the way.
static LegStep	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract java.lang.String	geometry() Gives the geometry of the leg step.
abstract java.util.List<StepIntersection>	intersections() Provides a list of all the intersections connected to the current way the user is traveling along.
abstract StepManeuver	maneuver() A StepManeuver object that typically represents the first coordinate making up the geometry().
abstract java.lang.String	mode() indicates the mode of transportation in the step.
abstract java.lang.String	name() String with the name of the way along which the travel proceeds.
abstract java.lang.String	pronunciation() The pronunciation hint of the way name.
abstract java.lang.String	ref() Any road designations associated with the road or path leading from this step's maneuver to the next step's maneuver.
abstract java.lang.String	rotaryName() An optional string indicating the name of the rotary.
abstract java.lang.String	rotaryPronunciation() An optional string indicating the pronunciation of the name of the rotary.
abstract java.lang.String	speedLimitSign() Speed limit sign type.
abstract java.lang.String	speedLimitUnit() Speed limit unit as per the locale.
abstract LegStep.Builder	toBuilder() Convert the current LegStep to its builder holding the currently assigned values.
static com.google.gson.TypeAdapter<LegStep>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.
abstract 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 double	weight() Specifies a decimal precision of edge weights, default value 1.

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

toJson

Methods inherited from class java.lang.Object

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

Field Detail

MUTCD

public static final java.lang.String MUTCD

LegStep.SpeedLimitSign accident.

See Also:

Constant Field Values

VIENNA

public static final java.lang.String VIENNA

LegStep.SpeedLimitSign congestion.

See Also:

Constant Field Values

Constructor Detail

LegStep

public LegStep()

Method Detail

builder

public static LegStep.Builder builder()

Create a new instance of this class by using the LegStep.Builder class.

Returns:

this classes LegStep.Builder for creating a new instance

Since:

3.0.0

distance

public abstract double distance()

The distance traveled from the maneuver to the next LegStep.

Returns:

a double number with unit meters

Since:

1.0.0

duration

public abstract double duration()

The estimated travel time from the maneuver to the next LegStep.

Returns:

a double number with unit seconds

Since:

1.0.0

durationTypical

@Nullable
 @SerializedName(value="duration_typical")
public abstract java.lang.Double durationTypical()

The typical travel time for traversing this LegStep. There's a delay along the LegStep if you subtract this durationTypical() value from the LegStep duration() value and the resulting difference is greater than 0. The delay is because of any number of real-world situations (road repair, traffic jam, etc).

Returns:

a double number with unit seconds

Since:

5.5.0

speedLimitUnit

@Nullable
public abstract java.lang.String speedLimitUnit()

Speed limit unit as per the locale.

Returns:

unit of the speed limit

speedLimitSign

@Nullable
public abstract java.lang.String speedLimitSign()

Speed limit sign type.

See Also:

LegStep.SpeedLimitSign

geometry

@Nullable
public abstract java.lang.String geometry()

Gives the geometry of the leg step.

Returns:

an encoded polyline string

Since:

1.0.0

name

@Nullable
public abstract java.lang.String name()

String with the name of the way along which the travel proceeds.

Returns:

a String representing the way along which the travel proceeds

Since:

1.0.0

ref

@Nullable
public abstract java.lang.String ref()

Any road designations associated with the road or path leading from this step's maneuver to the next step's maneuver. Optionally included, if data is available. If multiple road designations are associated with the road, they are separated by semicolons. A road designation typically consists of an alphabetic network code (identifying the road type or numbering system), a space or hyphen, and a route number. You should not assume that the network code is globally unique: for example, a network code of "NH" may appear on a "National Highway" or "New Hampshire". Moreover, a route number may not even uniquely identify a road within a given network.

Returns:

String with reference number or code of the way along which the travel proceeds. Optionally included, if data is available.

Since:

2.0.0

destinations

@Nullable
public abstract java.lang.String destinations()

String with the destinations of the way along which the travel proceeds.

Returns:

String with the destinations of the way along which the travel proceeds. Optionally included, if data is available

Since:

2.0.0

mode

@NonNull
public abstract java.lang.String mode()

indicates the mode of transportation in the step.

Returns:

String indicating the mode of transportation.

Since:

1.0.0

pronunciation

@Nullable
public abstract java.lang.String pronunciation()

The pronunciation hint of the way name. Will be undefined if no pronunciation is hit.

Returns:

String with the pronunciation

Since:

2.0.0

rotaryName

@Nullable
 @SerializedName(value="rotary_name")
public abstract 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.

Returns:

String with the rotary name

Since:

2.0.0

rotaryPronunciation

@Nullable
 @SerializedName(value="rotary_pronunciation")
public abstract 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.

Returns:

String in IPA with the rotary name's pronunciation.

Since:

2.0.0

maneuver

@NonNull
public abstract StepManeuver maneuver()

A StepManeuver object that typically represents the first coordinate making up the geometry().

Returns:

new StepManeuver object

Since:

1.0.0

voiceInstructions

@Nullable
public abstract 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.

Returns:

a list of voice instructions which can be triggered on this current step

Since:

3.0.0

bannerInstructions

@Nullable
public abstract java.util.List<BannerInstructions> bannerInstructions()

If in your request you set NbmapDirections.Builder#bannerInstructions() to true, you'll receive a list of BannerInstructions which encompasses all information necessary for creating a visual cue about a given LegStep.

Returns:

a list of BannerInstructionss which help display visual cues inside your application

Since:

3.0.0

drivingSide

@Nullable
 @SerializedName(value="driving_side")
public abstract java.lang.String drivingSide()

The legal driving side at the location for this step. Result will either be left or right.

Returns:

a string with either a left or right value

Since:

3.0.0

weight

public abstract double weight()

Specifies a decimal precision of edge weights, default value 1.

Returns:

a decimal precision double value

Since:

2.1.0

intersections

@Nullable
public abstract java.util.List<StepIntersection> intersections()

Provides a list of all the intersections connected to the current way the user is traveling along.

Returns:

list of StepIntersection representing all intersections along the step

Since:

1.3.0

exits

@Nullable
public abstract java.lang.String exits()

String with the exit numbers or names of the way. Optionally included, if data is available.

Returns:

a String identifying the exit number or name

Since:

3.0.0

toBuilder

public abstract LegStep.Builder toBuilder()

Convert the current LegStep 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 LegStep.

Returns:

a LegStep.Builder with the same values set to match the ones defined in this LegStep

Since:

3.1.0

typeAdapter

public static com.google.gson.TypeAdapter<LegStep> 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 LegStep 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 LegStep

Returns:

a new instance of this class defined by the values passed inside this static factory method

Since:

3.4.0