com.mapbox.api.directions.v5.models

Class RestStop

java.lang.Object

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

com.mapbox.api.directions.v5.models.RestStop

All Implemented Interfaces:

java.io.Serializable

public abstract class RestStop
extends DirectionsJsonObject

An object containing information about passing rest stops along the route. Only available on the DirectionsCriteria.PROFILE_DRIVING profile.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
RestStop()

Method Summary

Modifier and Type	Method and Description
abstract java.util.List<Amenity>	amenities() The list of amenities at the rest stop if available.
static RestStop.Builder	builder() Create a new instance of this class by using the RestStop.Builder class.
static RestStop	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract java.lang.String	guideMap()
abstract java.lang.String	name() The name of the rest stop.
abstract RestStop.Builder	toBuilder() Convert the current RestStop to its builder holding the currently assigned values.
abstract java.lang.String	type() The type of rest stop, either `rest_area` (includes parking only) or `service_area` (includes amenities such as gas or restaurants).
static com.google.gson.TypeAdapter<RestStop>	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

RestStop

public RestStop()

Method Detail

type

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

The type of rest stop, either `rest_area` (includes parking only) or `service_area` (includes amenities such as gas or restaurants). Note that adding new possible types is not considered a breaking change.

name

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

The name of the rest stop. Optionally included if data is available.

amenities

@Nullable
public abstract java.util.List<Amenity> amenities()

The list of amenities at the rest stop if available.

guideMap

@Nullable
 @SerializedName(value="guidemap")
public abstract java.lang.String guideMap()

builder

public static RestStop.Builder builder()

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

Returns:

this classes RestStop.Builder for creating a new instance

toBuilder

public abstract RestStop.Builder toBuilder()

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

Returns:

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

typeAdapter

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

fromJson

public static RestStop 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 an Incident

Returns:

a new instance of this class defined by the values passed in the method