com.mapbox.api.directions.v5.models

Class RestStop.Builder

java.lang.Object

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

Enclosing class:

RestStop

public abstract static class RestStop.Builder
extends java.lang.Object

This builder can be used to set the values describing the RestStop.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract RestStop.Builder	amenities(java.util.List<Amenity> amenities) The list of amenities at the rest stop if available.
abstract RestStop	build() Build a new RestStop object.
abstract RestStop.Builder	guideMap(java.lang.String guideMap)
abstract RestStop.Builder	name(java.lang.String name) The name of the rest stop.
abstract RestStop.Builder	type(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).
T	unrecognizedJsonProperties(java.util.Map<java.lang.String,com.google.gson.JsonElement> unrecognizedProperties) Use this method to add parameters which are not present in the model yet but are supported on the Directions API side in the response.

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

type

@NonNull
public abstract RestStop.Builder type(@Nullable
                                               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.

Parameters:

type - rest stop type

name

@NonNull
public abstract RestStop.Builder name(@Nullable
                                               java.lang.String name)

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

Parameters:

name - rest stop name

amenities

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

The list of amenities at the rest stop if available.

Parameters:

amenities - list of amenities

guideMap

@NonNull
public abstract RestStop.Builder guideMap(@Nullable
                                                   java.lang.String guideMap)

build

@NonNull
public abstract RestStop build()

Build a new RestStop object.

Returns:

a new RestStop using the provided values in this builder

unrecognizedJsonProperties

@NonNull
public T unrecognizedJsonProperties(@Nullable
                                             java.util.Map<java.lang.String,com.google.gson.JsonElement> unrecognizedProperties)

Use this method to add parameters which are not present in the model yet but are supported on the Directions API side in the response. Use it for experimental parameters.

Parameters:

unrecognizedProperties - parameters to add to request