com.mapbox.api.directions.v5.models

Class BannerView.Builder

java.lang.Object

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

Enclosing class:

BannerView

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

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

Since:

5.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract BannerView	build() Build a new BannerView object.
abstract BannerView.Builder	components(java.util.List<BannerComponents> components) A part or element of the BannerInstructions.
abstract BannerView.Builder	modifier(java.lang.String modifier) This indicates the mode of the maneuver.
abstract BannerView.Builder	text(java.lang.String text) Plain text with all the BannerComponents text combined.
abstract BannerView.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 BannerView.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:

5.0.0

components

public abstract BannerView.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:

5.0.0

type

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

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

Parameters:

type - String with type of maneuver

Returns:

this builder for chaining options together

Since:

5.0.0

See Also:

StepManeuver.StepManeuverType

modifier

public abstract BannerView.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:

5.0.0

build

public abstract BannerView build()

Build a new BannerView object.

Returns:

a new BannerView using the provided values in this builder

Since:

5.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