com.mapbox.api.directions.v5.models

Class Amenity.Builder

java.lang.Object

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

Enclosing class:

Amenity

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

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract Amenity.Builder	brand(java.lang.String brand) The brand name of the amenity.
abstract Amenity	build() Build a new Amenity object.
abstract Amenity.Builder	name(java.lang.String name) The name of the amenity.
abstract Amenity.Builder	type(java.lang.String type) The type of amenity, includes amenities such as gas, restaurants etc.
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 Amenity.Builder type(@NonNull
                                              java.lang.String type)

The type of amenity, includes amenities such as gas, restaurants etc. Note that adding new possible types is not considered a breaking change.

Parameters:

type - amenity type

name

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

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

Parameters:

name - amenity name

brand

@NonNull
public abstract Amenity.Builder brand(@Nullable
                                               java.lang.String brand)

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

Parameters:

brand - amenity brand name

build

@NonNull
public abstract Amenity build()

Build a new Amenity object.

Returns:

a new Amenity 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