com.nbmap.api.directions.v5.models

Class BannerInstructions.Builder

java.lang.Object

com.nbmap.api.directions.v5.models.BannerInstructions.Builder

Enclosing class:

BannerInstructions

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

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

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract BannerInstructions	build() Build a new BannerInstructions object.
abstract BannerInstructions.Builder	distanceAlongGeometry(double distanceAlongGeometry) Distance in meters from the beginning of the step at which the visual instruction should be visible.
abstract BannerInstructions.Builder	primary(BannerText primary) Main visual information about the LegStep.
abstract BannerInstructions.Builder	secondary(BannerText secondary) Ancillary visual information about the LegStep.
abstract BannerInstructions.Builder	sub(BannerText sub) Additional information that is included if we feel the driver needs a heads up about something.
abstract BannerInstructions.Builder	view(BannerView view) Optional image to display for an upcoming maneuver.

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

distanceAlongGeometry

public abstract BannerInstructions.Builder distanceAlongGeometry(double distanceAlongGeometry)

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

Parameters:

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

Returns:

this builder for chaining options together

Since:

3.0.0

primary

public abstract BannerInstructions.Builder primary(@NonNull
                                                   BannerText primary)

Main visual information about the LegStep.

Parameters:

primary - BannerText representing the primary visual information

Returns:

this builder for chaining options together

Since:

3.0.0

secondary

public abstract BannerInstructions.Builder secondary(@Nullable
                                                     BannerText secondary)

Ancillary visual information about the LegStep.

Parameters:

secondary - BannerText representing the secondary visual information

Returns:

this builder for chaining options together

Since:

3.0.0

sub

public abstract BannerInstructions.Builder sub(@Nullable
                                               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.

Parameters:

sub - BannerText representing the sub visual information

Returns:

BannerText representing the sub visual information

Since:

3.2.0

view

public abstract BannerInstructions.Builder view(@Nullable
                                                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.

Parameters:

view - BannerView representing the sub visual information

Returns:

this builder for chaining options together

Since:

5.0.0

build

public abstract BannerInstructions build()

Build a new BannerInstructions object.

Returns:

a new BannerInstructions using the provided values in this builder

Since:

3.0.0