com.mapbox.api.directions.v5.models

Class Amenity

java.lang.Object

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

com.mapbox.api.directions.v5.models.Amenity

All Implemented Interfaces:

java.io.Serializable

public abstract class Amenity
extends DirectionsJsonObject

An object containing information about amenities available at 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	Amenity.Builder This builder can be used to set the values describing the Amenity.

Constructor Summary

Constructors

Constructor and Description
Amenity()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	brand() The brand name of the amenity.
static Amenity.Builder	builder() Create a new instance of this class by using the Amenity.Builder class.
static Amenity	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract java.lang.String	name() The name of the amenity.
abstract Amenity.Builder	toBuilder() Convert the current Amenity to its builder holding the currently assigned values.
abstract java.lang.String	type() The type of amenities such as gas, restaurants, shopping, bank, atm etc.
static com.google.gson.TypeAdapter<Amenity>	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

Amenity

public Amenity()

Method Detail

type

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

The type of amenities such as gas, restaurants, shopping, bank, atm etc. For a list of supported amenity types see DirectionsCriteria.AmenityTypeCriteria.

name

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

The name of the amenity. Optionally included if data is available.

brand

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

The brand name of the amenity. Optionally included if data is available.

builder

public static Amenity.Builder builder()

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

Returns:

this classes Amenity.Builder for creating a new instance

toBuilder

public abstract Amenity.Builder toBuilder()

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

Returns:

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

typeAdapter

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