com.mapbox.api.directions.v5.models

Class MapboxShield.Builder

java.lang.Object

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

Enclosing class:

MapboxShield

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

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

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract MapboxShield.Builder	baseUrl(java.lang.String baseUrl) Base url to query the styles endpoint.
abstract MapboxShield	build() Build a new MapboxShield object.
abstract MapboxShield.Builder	displayRef(java.lang.String displayRef) String indicating the display ref.
abstract MapboxShield.Builder	name(java.lang.String name) String indicating the name of the route shield.
abstract MapboxShield.Builder	textColor(java.lang.String textColor) String indicating the color of the text to be rendered on the route shield.
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

baseUrl

public abstract MapboxShield.Builder baseUrl(java.lang.String baseUrl)

Base url to query the styles endpoint.

Parameters:

baseUrl - base url to query the styles endpoint

Returns:

a MapboxShield.Builder object

name

public abstract MapboxShield.Builder name(java.lang.String name)

String indicating the name of the route shield.

Parameters:

name - name of the shield

Returns:

a MapboxShield.Builder object

textColor

public abstract MapboxShield.Builder textColor(java.lang.String textColor)

String indicating the color of the text to be rendered on the route shield.

Parameters:

textColor - color of the text to be rendered on the route shield

Returns:

a MapboxShield.Builder object

displayRef

public abstract MapboxShield.Builder displayRef(java.lang.String displayRef)

String indicating the display ref.

Parameters:

displayRef - display ref for the shield

Returns:

a MapboxShield.Builder object

build

public abstract MapboxShield build()

Build a new MapboxShield object.

Returns:

a new MapboxShield using the provided values in this builder

Since:

3.0.0

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