com.nbmap.api.directions.v5.models

Class StepIntersection.Builder

java.lang.Object

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

Enclosing class:

StepIntersection

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

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

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract StepIntersection.Builder	adminIndex(java.lang.Integer adminIndex) The zero-based index into the admin list on the route leg for this intersection.
abstract StepIntersection.Builder	bearings(java.util.List<java.lang.Integer> bearing) An integer array of bearing values available at the step intersection.
abstract StepIntersection	build() Build a new StepIntersection object.
abstract StepIntersection.Builder	classes(java.util.List<java.lang.String> classes) A list of strings signifying the classes of the road exiting the intersection.
abstract StepIntersection.Builder	entry(java.util.List<java.lang.Boolean> entry) A list of entry flags, corresponding in a 1:1 relationship to the bearings.
abstract StepIntersection.Builder	geometryIndex(java.lang.Integer geometryIndex) The zero-based index for the intersection.
abstract StepIntersection.Builder	in(java.lang.Integer in) Index into bearings/entry array.
abstract StepIntersection.Builder	isUrban(java.lang.Boolean isUrban) A boolean indicating whether the road exiting the intersection is considered to be in an urban area.
abstract StepIntersection.Builder	lanes(java.util.List<IntersectionLanes> lanes) Array of lane objects that represent the available turn lanes at the intersection.
abstract StepIntersection.Builder	nbmapStreetsV8(NbmapStreetsV8 street) An object containing detailed information about the road exiting the intersection along the route.
abstract StepIntersection.Builder	out(java.lang.Integer out) Index out of the bearings/entry array.
abstract StepIntersection.Builder	rawLocation(double[] rawLocation) The rawLocation as a double array.
abstract StepIntersection.Builder	restStop(RestStop restStop) An object containing information about passing rest stops along the route.
abstract StepIntersection.Builder	tollCollection(TollCollection tollCollection) An object containing information about a toll collection point along the route.
abstract StepIntersection.Builder	tunnelName(java.lang.String tunnelName) Name of the tunnel.

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

bearings

public abstract StepIntersection.Builder bearings(@Nullable
                                                  java.util.List<java.lang.Integer> bearing)

An integer array of bearing values available at the step intersection.

Parameters:

bearing - An array of bearing values (for example [0,90,180,270]) that are available at the intersection. The bearings describe all available roads at the intersection.

Returns:

this builder for chaining options together

Since:

3.0.0

classes

public abstract StepIntersection.Builder classes(@Nullable
                                                 java.util.List<java.lang.String> classes)

A list of strings signifying the classes of the road exiting the intersection. Possible values:

• toll: the road continues on a toll road
• ferry: the road continues on a ferry
• restricted: the road continues on with access restrictions
• motorway: the road continues on a motorway

Parameters:

classes - a list of strings containing the classes of the road exiting the intersection

Returns:

this builder for chaining options together

Since:

3.0.0

entry

public abstract StepIntersection.Builder entry(@Nullable
                                               java.util.List<java.lang.Boolean> entry)

A list of entry flags, corresponding in a 1:1 relationship to the bearings. A value of true indicates that the respective road could be entered on a valid route. false indicates that the turn onto the respective road would violate a restriction.

Parameters:

entry - a Boolean list of entry flags, corresponding in a 1:1 relationship to the bearings

Returns:

this builder for chaining options together

Since:

3.0.0

in

public abstract StepIntersection.Builder in(@Nullable
                                            java.lang.Integer in)

Index into bearings/entry array. Used to calculate the bearing before the turn. Namely, the clockwise angle from true north to the direction of travel before the maneuver/passing the intersection. To get the bearing in the direction of driving, the bearing has to be rotated by a value of 180. The value is not supplied for departure maneuvers.

Parameters:

in - index into bearings/entry array

Returns:

this builder for chaining options together

Since:

3.0.0

out

public abstract StepIntersection.Builder out(@Nullable
                                             java.lang.Integer out)

Index out of the bearings/entry array. Used to extract the bearing after the turn. Namely, The clockwise angle from true north to the direction of travel after the maneuver/passing the intersection. The value is not supplied for arrive maneuvers.

Parameters:

out - index out of the bearings/entry array

Returns:

this builder for chaining options together

Since:

3.0.0

lanes

public abstract StepIntersection.Builder lanes(@Nullable
                                               java.util.List<IntersectionLanes> lanes)

Array of lane objects that represent the available turn lanes at the intersection. If no lane information is available for an intersection, the lanes property will not be present. Lanes are provided in their order on the street, from left to right.

Parameters:

lanes - array of lane objects that represent the available turn lanes at the intersection

Returns:

this builder for chaining options together

Since:

3.0.0

geometryIndex

public abstract StepIntersection.Builder geometryIndex(@Nullable
                                                       java.lang.Integer geometryIndex)

The zero-based index for the intersection. This value can be used to apply the duration annotation that corresponds with the intersection. Only available on the driving profile.

Parameters:

geometryIndex - index for the intersection

Returns:

this builder for chaining options together

isUrban

@Nullable
public abstract StepIntersection.Builder isUrban(@Nullable
                                                           java.lang.Boolean isUrban)

A boolean indicating whether the road exiting the intersection is considered to be in an urban area. This value is determined by the density of the surrounding road network. Only available on the DirectionsCriteria.PROFILE_DRIVING profile.

Parameters:

isUrban - indicating whether the road exiting the intersection is in an urban area

Returns:

this builder for chaining options together

adminIndex

@Nullable
public abstract StepIntersection.Builder adminIndex(@Nullable
                                                              java.lang.Integer adminIndex)

The zero-based index into the admin list on the route leg for this intersection. Use this field to look up the ISO-3166-1 country code for this point on the route. Only available on the `driving` profile.

Parameters:

adminIndex - zero-based index into the admin list on the route leg for this intersection

Returns:

this builder for chaining options together

restStop

@Nullable
public abstract StepIntersection.Builder restStop(@Nullable
                                                            RestStop restStop)

An object containing information about passing rest stops along the route. Only available on the `driving` profile.

Parameters:

restStop - object containing information about passing rest stops along the route.

Returns:

this builder for chaining options together

tollCollection

@Nullable
public abstract StepIntersection.Builder tollCollection(@Nullable
                                                                  TollCollection tollCollection)

An object containing information about a toll collection point along the route. This is a payment booth or overhead electronic gantry payment booth or overhead electronic gantry where toll charge is collected.

Parameters:

tollCollection - object containing information about a toll collection point along the route.

Returns:

this builder for chaining options together

nbmapStreetsV8

@Nullable
public abstract StepIntersection.Builder nbmapStreetsV8(@Nullable
                                                                  NbmapStreetsV8 street)

An object containing detailed information about the road exiting the intersection along the route. Properties in this object correspond to properties in the StepIntersection.classes() specification. Only available on the DirectionsCriteria.PROFILE_DRIVING profile.

Parameters:

street - an object containing detailed road information.

Returns:

this builder for chaining options together

tunnelName

public abstract StepIntersection.Builder tunnelName(@Nullable
                                                    java.lang.String tunnelName)

Name of the tunnel. Value is present only if class is tunnel.

Parameters:

tunnelName - name of the tunnel

Returns:

this builder for chaining options together

rawLocation

public abstract StepIntersection.Builder rawLocation(@NonNull
                                                     double[] rawLocation)

The rawLocation as a double array. Once the StepIntersection object's created, this raw location gets converted into a Point object and is public exposed as such. The double array should have a length of two, index 0 being the longitude and index 1 being latitude.

Parameters:

rawLocation - a double array with a length of two, index 0 being the longitude and index 1 being latitude.

Returns:

this builder for chaining options together

Since:

3.0.0

build

public abstract StepIntersection build()

Build a new StepIntersection object.

Returns:

a new StepIntersection using the provided values in this builder

Since:

3.0.0