com.mapbox.api.directions.v5.models

Class BannerText.Builder

java.lang.Object

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

Enclosing class:

BannerText

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

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

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract BannerText	build() Build a new BannerText object.
abstract BannerText.Builder	components(java.util.List<BannerComponents> components) A part or element of the BannerInstructions.
abstract BannerText.Builder	degrees(java.lang.Double degrees) The degrees at which you will be exiting a roundabout, assuming `180` indicates going straight through the roundabout.
abstract BannerText.Builder	drivingSide(java.lang.String drivingSide) A string representing which side the of the street people drive on in that location.
abstract BannerText.Builder	modifier(java.lang.String modifier) This indicates the mode of the maneuver.
abstract BannerText.Builder	text(java.lang.String text) Plain text with all the BannerComponents text combined.
abstract BannerText.Builder	type(java.lang.String type) This indicates the type of maneuver.
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

text

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

Plain text with all the BannerComponents text combined.

Parameters:

text - plain text with all the BannerComponents text items combined

Returns:

this builder for chaining options together

Since:

3.0.0

components

public abstract BannerText.Builder components(java.util.List<BannerComponents> components)

A part or element of the BannerInstructions.

Parameters:

components - a BannerComponents specific to a LegStep

Returns:

this builder for chaining options together

Since:

3.0.0

type

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

This indicates the type of maneuver. See BannerText.type() for a full list of options.

Parameters:

type - String with type of maneuver

Returns:

this builder for chaining options together

Since:

3.0.0

See Also:

StepManeuver.StepManeuverType

modifier

public abstract BannerText.Builder modifier(@Nullable
                                            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.

Parameters:

modifier - String with modifier

Returns:

this builder for chaining options together

Since:

3.0.0

degrees

public abstract BannerText.Builder degrees(java.lang.Double degrees)

The degrees at which you will be exiting a roundabout, assuming `180` indicates going straight through the roundabout.

Parameters:

degrees - at which you will be exiting a roundabout

Returns:

this builder for chaining options together

Since:

3.0.0

drivingSide

public abstract BannerText.Builder drivingSide(@Nullable
                                               java.lang.String drivingSide)

A string representing which side the of the street people drive on in that location. Can be 'left' or 'right'.

Parameters:

drivingSide - either `left` or `right`

Returns:

this builder for chaining options together

Since:

3.0.0

build

public abstract BannerText build()

Build a new BannerText object.

Returns:

a new BannerText 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