com.nbmap.api.directions.v5.models

Class IntersectionLanes.Builder

java.lang.Object

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

Enclosing class:

IntersectionLanes

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

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

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract IntersectionLanes.Builder	active(java.lang.Boolean active) Indicates whether this lane is a preferred lane (true) or not (false).
abstract IntersectionLanes	build() Build a new IntersectionLanes object.
abstract IntersectionLanes.Builder	indications(java.util.List<java.lang.String> indications) list that can be made up of multiple signs such as left, right, etc.
abstract IntersectionLanes.Builder	valid(java.lang.Boolean valid) Provide a boolean value you can use to determine if the given lane is valid for the user to complete the maneuver.
abstract IntersectionLanes.Builder	validIndication(java.lang.String validIndication) Shows which of the lane indications is applicable to the current route, when there is more than one.

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

valid

public abstract IntersectionLanes.Builder valid(@Nullable
                                                java.lang.Boolean valid)

Provide a boolean value you can use to determine if the given lane is valid for the user to complete the maneuver.

Parameters:

valid - Boolean value for whether this lane can be taken to complete the maneuver. For instance, if the lane array has four objects and the first two are marked as valid, then the driver can take either of the left lanes and stay on the route.

Returns:

this builder for chaining options together

Since:

3.0.0

active

public abstract IntersectionLanes.Builder active(@Nullable
                                                 java.lang.Boolean active)

Indicates whether this lane is a preferred lane (true) or not (false).

Parameters:

active - Boolean value that indicates whether this lane is a preferred lane (true) or not (false).

Returns:

this builder for chaining options together

validIndication

public abstract IntersectionLanes.Builder validIndication(@Nullable
                                                          java.lang.String validIndication)

Shows which of the lane indications is applicable to the current route, when there is more than one.

Parameters:

validIndication - lane indications applicable to the current route, when there is more than one.

Returns:

this builder for chaining options together

indications

public abstract IntersectionLanes.Builder indications(@Nullable
                                                      java.util.List<java.lang.String> indications)

list that can be made up of multiple signs such as left, right, etc.

Parameters:

indications - list of signs for each turn lane. There can be multiple signs. For example, a turning lane can have a sign with an arrow pointing left and another sign with an arrow pointing straight.

Returns:

this builder for chaining options together

Since:

3.0.0

build

public abstract IntersectionLanes build()

Build a new IntersectionLanes object.

Returns:

a new IntersectionLanes using the provided values in this builder

Since:

3.0.0