com.mapbox.api.directions.v5.models

Class BannerView

java.lang.Object

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

com.mapbox.api.directions.v5.models.BannerView

All Implemented Interfaces:

java.io.Serializable

public abstract class BannerView
extends DirectionsJsonObject

Includes both plain text information that can be visualized inside your navigation application along with the text string broken down into BannerComponents which may or may not include a image url. To receive this information, your request must have MapboxDirections.bannerInstructions() set to true.

Since:

5.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
BannerView()

Method Summary

Modifier and Type	Method and Description
static BannerView.Builder	builder() Create a new instance of this class by using the BannerView.Builder class.
abstract java.util.List<BannerComponents>	components() A part or element of the BannerInstructions.
static BannerView	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract java.lang.String	modifier() This indicates the mode of the maneuver.
abstract java.lang.String	text() Plain text with all the BannerComponents text combined.BannerInstructions.
abstract BannerView.Builder	toBuilder() Convert the current BannerView to its builder holding the currently assigned values.
abstract java.lang.String	type() This indicates the type of maneuver.
static com.google.gson.TypeAdapter<BannerView>	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

toJson

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BannerView

public BannerView()

Method Detail

builder

public static BannerView.Builder builder()

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

Returns:

this classes BannerView.Builder for creating a new instance

Since:

5.0.0

text

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

Plain text with all the BannerComponents text combined.BannerInstructions.

Returns:

plain text with all the BannerComponents text items combined

Since:

5.0.0

components

@Nullable
public abstract java.util.List<BannerComponents> components()

A part or element of the BannerInstructions.

Returns:

a BannerComponents specific to a LegStep

Since:

5.0.0

type

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

This indicates the type of maneuver.

Returns:

String with type of maneuver

Since:

5.0.0

See Also:

StepManeuver.StepManeuverType

modifier

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

This indicates the mode of the maneuver. If type is of turn, the modifier indicates the change in direction accomplished through the turn. If the type is of depart/arrive, the modifier indicates the position of waypoint from the current direction of travel.

Returns:

String with modifier

Since:

5.0.0

toBuilder

public abstract BannerView.Builder toBuilder()

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

Returns:

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

Since:

5.0.0

typeAdapter

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

5.0.0

fromJson

public static BannerView 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 BannerText

Returns:

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

Since:

5.0.0