com.mapbox.api.directions.v5.models

Class BannerComponents.Builder

java.lang.Object

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

Enclosing class:

BannerComponents

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

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

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract BannerComponents.Builder	abbreviation(java.lang.String abbreviation) The abbreviated form of text.
abstract BannerComponents.Builder	abbreviationPriority(java.lang.Integer abbreviationPriority) An integer indicating the order in which the abbreviation abbr should be used in place of text.
abstract BannerComponents.Builder	active(java.lang.Boolean activeState) A boolean telling you if that lane can be used to complete the upcoming maneuver.
abstract BannerComponents	build() Build a new BannerComponents object.
abstract BannerComponents.Builder	directions(java.util.List<java.lang.String> directions) A List of directions indicating which way you can go from a lane (left, right, or straight).
abstract BannerComponents.Builder	imageBaseUrl(java.lang.String imageBaseUrl) In some cases when the LegStep is a highway or major roadway, there might be a shield icon that's included to better identify to your user to roadway.
abstract BannerComponents.Builder	text(java.lang.String text) A snippet of the full BannerText.text() which can be used for visually altering parts of the full string.
abstract BannerComponents.Builder	type(java.lang.String type) String giving you more context about the component which may help in visual markup/display choices.

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

text

public abstract BannerComponents.Builder text(java.lang.String text)

A snippet of the full BannerText.text() which can be used for visually altering parts of the full string.

Parameters:

text - a single snippet of the full text instruction

Returns:

this builder for chaining options together

Since:

3.0.0

type

public abstract BannerComponents.Builder type(java.lang.String type)

String giving you more context about the component which may help in visual markup/display choices. If the type of the components is unknown it should be treated as text.

Possible values:

• text (default): indicates the text is part of the instructions and no other type
• icon: this is text that can be replaced by an icon, see imageBaseURL
• delimiter: this is text that can be dropped and should be dropped if you are rendering icons
• exit-number: the exit number for the maneuver
• exit: the word for exit in the local language

Parameters:

type - String type from above list

Returns:

this builder for chaining options together

Since:

3.0.0

abbreviation

public abstract BannerComponents.Builder abbreviation(@Nullable
                                                      java.lang.String abbreviation)

The abbreviated form of text.

Parameters:

abbreviation - for the given text of this component

Returns:

this builder for chaining options together

Since:

3.0.0

abbreviationPriority

public abstract BannerComponents.Builder abbreviationPriority(@Nullable
                                                              java.lang.Integer abbreviationPriority)

An integer indicating the order in which the abbreviation abbr should be used in place of text. The highest priority is 0 and a higher integer value indicates a lower priority. There are no gaps in integer values.

Multiple components can have the same abbreviationPriority and when this happens all components with the same abbr_priority should be abbreviated at the same time. Finding no larger values of abbreviationPriority indicates that the string is fully abbreviated.

Parameters:

abbreviationPriority - Integer indicating the order of the abbreviation

Returns:

this builder for chaining options together

Since:

3.0.0

imageBaseUrl

public abstract BannerComponents.Builder imageBaseUrl(@Nullable
                                                      java.lang.String imageBaseUrl)

In some cases when the LegStep is a highway or major roadway, there might be a shield icon that's included to better identify to your user to roadway. Note that this doesn't return the image itself but rather the url which can be used to download the file.

Parameters:

imageBaseUrl - the url which can be used to download the shield icon if one is avaliable

Returns:

this builder for chaining options together

Since:

3.0.0

directions

public abstract BannerComponents.Builder directions(java.util.List<java.lang.String> directions)

A List of directions indicating which way you can go from a lane (left, right, or straight). If the value is ['left', 'straight'], the driver can go straight or left from that lane. Present if this is a lane component.

Parameters:

directions - List of allowed directions from that lane

Returns:

this builder for chaining options together

Since:

3.2.0

active

public abstract BannerComponents.Builder active(java.lang.Boolean activeState)

A boolean telling you if that lane can be used to complete the upcoming maneuver. If multiple lanes are active, then they can all be used to complete the upcoming maneuver. Present if this is a lane component.

Parameters:

activeState - true, if the lane could be used for upcoming maneuver, false - otherwise

Returns:

this builder for chaining options together

Since:

3.2.0

build

public abstract BannerComponents build()

Build a new BannerComponents object.

Returns:

a new BannerComponents using the provided values in this builder

Since:

3.0.0