com.mapbox.api.directions.v5.models

Class DirectionsWaypoint

java.lang.Object

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

com.mapbox.api.directions.v5.models.DirectionsWaypoint

All Implemented Interfaces:

java.io.Serializable

public abstract class DirectionsWaypoint
extends DirectionsJsonObject

An input coordinate snapped to the roads network.

Since:

1.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
DirectionsWaypoint()

Method Summary

Modifier and Type	Method and Description
static DirectionsWaypoint.Builder	builder() Create a new instance of this class by using the DirectionsWaypoint.Builder class.
abstract java.lang.Double	distance() The straight-line distance from the coordinate specified in the query to the location it was snapped to.
static DirectionsWaypoint	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
com.mapbox.geojson.Point	location() A Point representing this waypoint location.
abstract java.lang.String	name() Provides the way name which the waypoint's coordinate is snapped to.
abstract DirectionsWaypoint.Builder	toBuilder() Convert the current DirectionsWaypoint to its builder holding the currently assigned values.
static com.google.gson.TypeAdapter<DirectionsWaypoint>	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

Constructor Detail

DirectionsWaypoint

public DirectionsWaypoint()

Method Detail

builder

public static DirectionsWaypoint.Builder builder()

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

Returns:

this classes DirectionsWaypoint.Builder for creating a new instance

Since:

3.0.0

name

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

Provides the way name which the waypoint's coordinate is snapped to.

Returns:

string with the name of the way the coordinate snapped to

Since:

1.0.0

location

@NonNull
public com.mapbox.geojson.Point location()

A Point representing this waypoint location. This point is snapped to the road network.

Returns:

GeoJson Point representing this waypoint location

Since:

3.0.0

distance

@Nullable
public abstract java.lang.Double distance()

The straight-line distance from the coordinate specified in the query to the location it was snapped to.

toBuilder

public abstract DirectionsWaypoint.Builder toBuilder()

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

Returns:

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

Since:

3.1.0

typeAdapter

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

Returns:

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

Since:

3.4.0