com.mapbox.api.directions.v5.models

Class MapboxShield

java.lang.Object

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

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

All Implemented Interfaces:

java.io.Serializable

public abstract class MapboxShield
extends DirectionsJsonObject

A part of the BannerComponents which includes a snippet of the route shield associated with the instruction. In cases where data is available, a base url will be provided to help in constructing an actual URL that can then be used to fetch a shield in the form of SVG. To receive this information, your request must have MapboxDirections.Builder#bannerInstructions() set to true.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
MapboxShield()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	baseUrl() Base url to query the styles endpoint.
static MapboxShield.Builder	builder() Create a new instance of this class by using the MapboxShield.Builder class.
abstract java.lang.String	displayRef() String indicating the display ref.
static MapboxShield	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() String indicating the name of the route shield.
abstract java.lang.String	textColor() String indicating the color of the text to be rendered on the route shield.
abstract MapboxShield.Builder	toBuilder() Convert the current MapboxShield to its builder holding the currently assigned values.
static com.google.gson.TypeAdapter<MapboxShield>	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

MapboxShield

public MapboxShield()

Method Detail

builder

public static MapboxShield.Builder builder()

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

Returns:

MapboxShield.Builder for creating a new instance

baseUrl

@SerializedName(value="base_url")
public abstract java.lang.String baseUrl()

Base url to query the styles endpoint.

Returns:

base url to query the styles endpoint

name

public abstract java.lang.String name()

String indicating the name of the route shield.

Returns:

name of the route shield

textColor

@SerializedName(value="text_color")
public abstract java.lang.String textColor()

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

Returns:

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

displayRef

@SerializedName(value="display_ref")
public abstract java.lang.String displayRef()

String indicating the display ref.

Returns:

String display ref

toBuilder

public abstract MapboxShield.Builder toBuilder()

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

Returns:

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

Since:

3.1.0

typeAdapter

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

Since:

3.0.0

fromJson

public static MapboxShield 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 a MapboxShield

Returns:

a new instance of this class defined by the values passed inside this static factory method