com.mapbox.api.directions.v5.models

Class BannerInstructions

java.lang.Object

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

com.mapbox.api.directions.v5.models.BannerInstructions

All Implemented Interfaces:

java.io.Serializable

public abstract class BannerInstructions
extends DirectionsJsonObject

Visual instruction information related to a particular LegStep useful for making UI elements inside your application such as banners. To receive this information, your request must MapboxDirections.Builder#bannerInstructions() have set to true.

Since:

3.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
BannerInstructions()

Method Summary

Modifier and Type	Method and Description
static BannerInstructions.Builder	builder() Create a new instance of this class by using the BannerInstructions.Builder class.
abstract double	distanceAlongGeometry() Distance in meters from the beginning of the step at which the visual instruction should be visible.
static BannerInstructions	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract BannerText	primary() A plain text representation stored inside a BannerText object.
abstract BannerText	secondary() Ancillary visual information about the LegStep.
abstract BannerText	sub() Additional information that is included if we feel the driver needs a heads up about something.
abstract BannerInstructions.Builder	toBuilder() Convert the current BannerInstructions to its builder holding the currently assigned values.
static com.google.gson.TypeAdapter<BannerInstructions>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.
abstract BannerView	view() Optional image to display for an upcoming maneuver.

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

BannerInstructions

public BannerInstructions()

Method Detail

builder

public static BannerInstructions.Builder builder()

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

Returns:

this classes BannerInstructions.Builder for creating a new instance

Since:

3.0.0

distanceAlongGeometry

public abstract double distanceAlongGeometry()

Distance in meters from the beginning of the step at which the visual instruction should be visible.

Returns:

double value representing the length from the steps first point to where the banner instruction should be displayed

Since:

3.0.0

primary

@NonNull
public abstract BannerText primary()

A plain text representation stored inside a BannerText object.

Returns:

a BannerText object which includes text for visually displaying current step information to the user

Since:

3.0.0

secondary

@Nullable
public abstract BannerText secondary()

Ancillary visual information about the LegStep.

Returns:

BannerText representing the secondary visual information

Since:

3.0.0

sub

@Nullable
public abstract BannerText sub()

Additional information that is included if we feel the driver needs a heads up about something. Can include information about the next maneuver (the one after the upcoming one), if the step is short - can be null, or can be lane information. If we have lane information, that trumps information about the next maneuver.

Returns:

BannerText representing the sub visual information

Since:

3.2.0

view

@Nullable
public abstract BannerView view()

Optional image to display for an upcoming maneuver. Used to provide a visual for complex junctions and maneuver. If the step is short the image should be displayed for the duration of the step, otherwise it is shown as you approach the maneuver.

Returns:

BannerView representing the secondary visual information

Since:

5.0.0

toBuilder

public abstract BannerInstructions.Builder toBuilder()

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

Returns:

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

Since:

3.1.0

typeAdapter

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

Returns:

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

Since:

3.4.0