com.mapbox.api.directions.v5.models

Class SilentWaypoint

java.lang.Object

com.mapbox.api.directions.v5.models.DirectionsJsonObject

com.mapbox.api.directions.v5.models.SilentWaypoint

All Implemented Interfaces:

java.io.Serializable

public abstract class SilentWaypoint
extends DirectionsJsonObject

Represents an information about silent waypoint in the leg index. See RouteLeg.viaWaypoints() for more details.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SilentWaypoint.Builder This builder can be used to set the values describing the SilentWaypoint.

Constructor Summary

Constructors

Constructor and Description
SilentWaypoint()

Method Summary

Modifier and Type	Method and Description
static SilentWaypoint.Builder	builder() Create a new instance of this class by using the SilentWaypoint.Builder class.
abstract double	distanceFromStart() The calculated distance, in meters, from the leg origin.
abstract int	geometryIndex() The associated leg shape index of the via waypoint location.
static com.google.gson.TypeAdapter<SilentWaypoint>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.
abstract int	waypointIndex() The associated waypoint index, excluding the origin (index 0) and destination.

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

Constructor Detail

SilentWaypoint

public SilentWaypoint()

Method Detail

builder

@NonNull
public static SilentWaypoint.Builder builder()

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

Returns:

SilentWaypoint.Builder for creating a new instance

waypointIndex

@SerializedName(value="waypoint_index")
public abstract int waypointIndex()

The associated waypoint index, excluding the origin (index 0) and destination.

Returns:

the associated waypoint index, excluding the origin (index 0) and destination.

distanceFromStart

@SerializedName(value="distance_from_start")
public abstract double distanceFromStart()

The calculated distance, in meters, from the leg origin.

Returns:

the calculated distance, in meters, from the leg origin.

geometryIndex

@SerializedName(value="geometry_index")
public abstract int geometryIndex()

The associated leg shape index of the via waypoint location.

Returns:

the associated leg shape index of the via waypoint location.

typeAdapter

@NonNull
public static com.google.gson.TypeAdapter<SilentWaypoint> 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