com.nbmap.api.directions.v5

Class NbmapDirections.Builder

java.lang.Object

com.nbmap.api.directions.v5.NbmapDirections.Builder

Enclosing class:

NbmapDirections

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

This builder is used to create a new request to the Nbmap Directions API. At a bare minimum, your request must include an access token, an origin, and a destination. All other fields can be left alone inorder to use the default behaviour of the API.

By default, the directions profile is set to driving (without traffic) but can be changed to reflect your users use-case.

Note to contributors: All optional booleans in this builder use the object Boolean rather than the primitive to allow for unset (null) values.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract NbmapDirections.Builder	accessToken(java.lang.String accessToken) Required to call when this is being built.
NbmapDirections.Builder	addAnnotation(java.lang.String annotation) Whether or not to return additional metadata along the route.
NbmapDirections.Builder	addApproach(java.lang.String approach) Indicates from which side of the road to approach a waypoint.
NbmapDirections.Builder	addApproaches(java.lang.String... approaches) Deprecated. use approaches(List)
NbmapDirections.Builder	addBearing(java.lang.Double angle, java.lang.Double tolerance) Optionally, Use to filter the road segment the waypoint will be placed on by direction and dictates the angle of approach.
NbmapDirections.Builder	addRadius(java.lang.Double radius) Optionally, set the maximum distance in meters that each coordinate is allowed to move when snapped to a nearby road segment.
NbmapDirections.Builder	addSnappingClosure(java.lang.Boolean snappingClosure) A boolean affecting snapping of waypoint location to the road segment.
NbmapDirections.Builder	addWaypoint(com.nbmap.geojson.Point waypoint) This can be used to set up to 23 additional in-between points which will act as pit-stops along the users route.
NbmapDirections.Builder	addWaypointIndex(java.lang.Integer waypointIndex) Optionally, set which input coordinates should be treated as waypoints / separate legs.
NbmapDirections.Builder	addWaypointIndices(java.lang.Integer... waypointIndices) Deprecated. use waypointIndices(List)
NbmapDirections.Builder	addWaypointName(java.lang.String waypointName) Custom names for waypoints used for the arrival instruction.
NbmapDirections.Builder	addWaypointNames(java.lang.String... waypointNames) Deprecated. use waypointNames(List)
NbmapDirections.Builder	addWaypointTarget(com.nbmap.geojson.Point waypointTarget) A point to specify drop-off locations that are distinct from the locations specified in coordinates.
NbmapDirections.Builder	addWaypointTargets(com.nbmap.geojson.Point... waypointTargets) Deprecated. use waypointTargets(List)
abstract NbmapDirections.Builder	alternatives(java.lang.Boolean alternatives) Optionally set whether to try to return alternative routes.
NbmapDirections.Builder	annotations(java.util.List<java.lang.String> annotations) Whether or not to return additional metadata along the route.
NbmapDirections.Builder	annotations(java.lang.String... annotations) Deprecated. use annotations(List)
NbmapDirections.Builder	approaches(java.util.List<java.lang.String> approaches) Indicates from which side of the road to approach a waypoint.
abstract NbmapDirections.Builder	bannerInstructions(java.lang.Boolean bannerInstructions) Request banner instructions object to be returned in your response.
abstract NbmapDirections.Builder	baseUrl(java.lang.String baseUrl) Optionally change the APIs base URL to something other then the default Nbmap one.
NbmapDirections.Builder	bearings(java.util.List<java.util.List<java.lang.Double>> bearings) Optionally, Use to filter the road segment the waypoint will be placed on by direction and dictates the angle of approach.
NbmapDirections	build() This uses the provided parameters set using the NbmapDirections.Builder and first checks that all values are valid, formats the values as strings for easier consumption by the API, and lastly creates a new NbmapDirections object with the values provided.
abstract NbmapDirections.Builder	clientAppName(java.lang.String clientAppName) Base package name or other simple string identifier.
abstract NbmapDirections.Builder	continueStraight(java.lang.Boolean continueStraight) Sets allowed direction of travel when departing intermediate waypoints.
NbmapDirections.Builder	destination(com.nbmap.geojson.Point destination) This sets the ending point on the map where the route will end.
abstract NbmapDirections.Builder	enableRefresh(java.lang.Boolean enableRefresh) Whether the routes should be refreshable via the directions refresh API.
abstract NbmapDirections.Builder	eventListener(okhttp3.EventListener eventListener) Adds an optional event listener to set in the OkHttp client.
abstract NbmapDirections.Builder	exclude(java.lang.String exclude) Exclude certain road types from routing.
abstract NbmapDirections.Builder	geometries(java.lang.String geometries) alter the default geometry being returned for the directions route.
NbmapDirections.Builder	get() Use GET method to request data.
abstract NbmapDirections.Builder	interceptor(okhttp3.Interceptor interceptor) Adds an optional interceptor to set in the OkHttp client.
NbmapDirections.Builder	language(java.util.Locale language) Set the instruction language for the directions request, the default is english.
abstract NbmapDirections.Builder	networkInterceptor(okhttp3.Interceptor interceptor) Adds an optional network interceptor to set in the OkHttp client.
NbmapDirections.Builder	origin(com.nbmap.geojson.Point origin) This sets the starting point on the map where the route will begin.
abstract NbmapDirections.Builder	overview(java.lang.String overview) Type of returned overview geometry.
NbmapDirections.Builder	post() Use POST method to request data.
abstract NbmapDirections.Builder	profile(java.lang.String profile) This selects which mode of transportation the user will be using while navigating from the origin to the final destination.
NbmapDirections.Builder	radiuses(java.lang.Double... radiuses) Deprecated. use radiuses(List)
NbmapDirections.Builder	radiuses(java.util.List<java.lang.Double> radiuses) Optionally, set the maximum distance in meters that each coordinate is allowed to move when snapped to a nearby road segment.
abstract NbmapDirections.Builder	roundaboutExits(java.lang.Boolean roundaboutExits) Optionally, set this to true if you want to enable instructions while exiting roundabouts and rotaries.
NbmapDirections.Builder	snappingClosures(java.util.List<java.lang.Boolean> snappingClosures) A list of booleans affecting snapping of waypoint locations to road segments.
abstract NbmapDirections.Builder	steps(java.lang.Boolean steps) Setting this will determine whether to return steps and turn-by-turn instructions.
abstract NbmapDirections.Builder	user(java.lang.String user) The username for the account that the directions engine runs on.
abstract NbmapDirections.Builder	voiceInstructions(java.lang.Boolean voiceInstructions) Request voice instructions objects to be returned in your response.
abstract NbmapDirections.Builder	voiceUnits(java.lang.String voiceUnits) Specify what unit you'd like voice and banner instructions to use.
abstract NbmapDirections.Builder	walkingOptions(com.nbmap.api.directions.v5.WalkingOptions walkingOptions) To be used to specify settings for use with the walking profile.
NbmapDirections.Builder	waypointIndices(java.util.List<java.lang.Integer> waypointIndices) Optionally, set which input coordinates should be treated as waypoints / separate legs.
NbmapDirections.Builder	waypointNames(java.util.List<java.lang.String> waypointNames) Custom names for waypoints used for the arrival instruction.
NbmapDirections.Builder	waypoints(java.util.List<com.nbmap.geojson.Point> waypoints) This can be used to set up to 23 additional in-between points which will act as pit-stops along the users route.
NbmapDirections.Builder	waypointTargets(java.util.List<com.nbmap.geojson.Point> waypointTargets) A list of points used to specify drop-off locations that are distinct from the locations specified in coordinates.

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

user

public abstract NbmapDirections.Builder user(@NonNull
                                             java.lang.String user)

The username for the account that the directions engine runs on. In most cases, this should always remain the default value of DirectionsCriteria.PROFILE_DEFAULT_USER.

Parameters:

user - a non-null string which will replace the default user used in the directions request

Returns:

this builder for chaining options together

Since:

1.0.0

profile

public abstract NbmapDirections.Builder profile(@NonNull
                                                java.lang.String profile)

This selects which mode of transportation the user will be using while navigating from the origin to the final destination. The options include driving, driving considering traffic, walking, and cycling. Using each of these profiles will result in different routing biases.

Parameters:

profile - required to be one of the String values found in the DirectionsCriteria.ProfileCriteria

Returns:

this builder for chaining options together

Since:

1.0.0

origin

public NbmapDirections.Builder origin(@NonNull
                                      com.nbmap.geojson.Point origin)

This sets the starting point on the map where the route will begin. It is one of the required parameters which must be set for a successful directions response.

Parameters:

origin - a GeoJson Point object representing the starting location for the route

Returns:

this builder for chaining options together

Since:

1.0.0

destination

public NbmapDirections.Builder destination(@NonNull
                                           com.nbmap.geojson.Point destination)

This sets the ending point on the map where the route will end. It is one of the required parameters which must be set for a successful directions response.

Parameters:

destination - a GeoJson Point object representing the starting location for the route

Returns:

this builder for chaining options together

Since:

1.0.0

addWaypoint

public NbmapDirections.Builder addWaypoint(@NonNull
                                           com.nbmap.geojson.Point waypoint)

This can be used to set up to 23 additional in-between points which will act as pit-stops along the users route. Note that if you are using the DirectionsCriteria.PROFILE_DRIVING_TRAFFIC that the max number of waypoints allowed in the request is currently limited to 1.

Parameters:

waypoint - a Point which represents the pit-stop or waypoint where you'd like one of the RouteLeg to navigate the user to

Returns:

this builder for chaining options together

Since:

3.0.0

waypoints

public NbmapDirections.Builder waypoints(@NonNull
                                         java.util.List<com.nbmap.geojson.Point> waypoints)

This can be used to set up to 23 additional in-between points which will act as pit-stops along the users route. Note that if you are using the DirectionsCriteria.PROFILE_DRIVING_TRAFFIC that the max number of waypoints allowed in the request is currently limited to 1.

Parameters:

waypoints - a list which represents the pit-stops or waypoints where you'd like one of the RouteLeg to navigate the user to

Returns:

this builder for chaining options together

alternatives

public abstract NbmapDirections.Builder alternatives(@Nullable
                                                     java.lang.Boolean alternatives)

Optionally set whether to try to return alternative routes. An alternative is classified as a route that is significantly different then the fastest route, but also still reasonably fast. Not in all circumstances such a route exists. At the moment at most one alternative can be returned.

Parameters:

alternatives - true if you'd like to receive an alternative route, otherwise false or null to use the APIs default value

Returns:

this builder for chaining options together

Since:

1.0.0

geometries

public abstract NbmapDirections.Builder geometries(java.lang.String geometries)

alter the default geometry being returned for the directions route. A null value will reset this field to the APIs default value vs this SDKs default value of DirectionsCriteria.GEOMETRY_POLYLINE6.

Note that while the API supports GeoJson as an option for geometry, this SDK intentionally removes this as an option since an encoded string for the geometry significantly reduces bandwidth on mobile devices and speeds up response time.

Parameters:

geometries - null if you'd like the default geometry, else one of the options found in DirectionsCriteria.GeometriesCriteria.

Returns:

this builder for chaining options together

Since:

2.0.0

overview

public abstract NbmapDirections.Builder overview(@Nullable
                                                 java.lang.String overview)

Type of returned overview geometry. Can be DirectionsCriteria.OVERVIEW_FULL (the most detailed geometry available), DirectionsCriteria.OVERVIEW_SIMPLIFIED (a simplified version of the full geometry), or DirectionsCriteria.OVERVIEW_FALSE (no overview geometry). The default is simplified. Passing in null will use the APIs default setting for the overview field.

Parameters:

overview - null or one of the options found in DirectionsCriteria.OverviewCriteria

Returns:

this builder for chaining options together

Since:

1.0.0

steps

public abstract NbmapDirections.Builder steps(@Nullable
                                              java.lang.Boolean steps)

Setting this will determine whether to return steps and turn-by-turn instructions. Can be set to either true or false to enable or disable respectively. null can also optionally be passed in to set the default behavior to match what the API does by default.

Parameters:

steps - true if you'd like step information

Returns:

this builder for chaining options together

Since:

1.0.0

continueStraight

public abstract NbmapDirections.Builder continueStraight(@Nullable
                                                         java.lang.Boolean continueStraight)

Sets allowed direction of travel when departing intermediate waypoints. If true the route will continue in the same direction of travel. If false the route may continue in the opposite direction of travel. API defaults to true for DirectionsCriteria.PROFILE_DRIVING and false for DirectionsCriteria.PROFILE_WALKING and DirectionsCriteria.PROFILE_CYCLING.

Parameters:

continueStraight - boolean true if you want to always continue straight, else false. Null can also be passed in here to use the APIs default option

Returns:

this builder for chaining options together

Since:

1.0.0

language

public NbmapDirections.Builder language(@Nullable
                                        java.util.Locale language)

Set the instruction language for the directions request, the default is english. Only a select number of languages are currently supported, reference the table provided in the see link below.

Parameters:

language - a Locale value representing the language you'd like the instructions to be written in when returned

Returns:

this builder for chaining options together

Since:

2.2.0

See Also:

Supported Languages

roundaboutExits

public abstract NbmapDirections.Builder roundaboutExits(@Nullable
                                                        java.lang.Boolean roundaboutExits)

Optionally, set this to true if you want to enable instructions while exiting roundabouts and rotaries.

Parameters:

roundaboutExits - true if you'd like extra roundabout instructions

Returns:

this builder for chaining options together

Since:

3.0.0

annotations

@Deprecated
public NbmapDirections.Builder annotations(@NonNull
                                                       java.lang.String... annotations)

Deprecated. use annotations(List)

Whether or not to return additional metadata along the route. Possible values are: DirectionsCriteria.ANNOTATION_DISTANCE, DirectionsCriteria.ANNOTATION_DURATION and DirectionsCriteria.ANNOTATION_CONGESTION. Several annotation can be used by separating them with ,.

Parameters:

annotations - string referencing one of the annotation direction criteria's. The strings restricted to one or multiple values inside the DirectionsCriteria.AnnotationCriteria or null which will result in no annotations being used

Returns:

this builder for chaining options together

Since:

2.1.0

See Also:

RouteLeg object documentation

annotations

public NbmapDirections.Builder annotations(@NonNull
                                           java.util.List<java.lang.String> annotations)

Whether or not to return additional metadata along the route. Possible values are: DirectionsCriteria.ANNOTATION_DISTANCE, DirectionsCriteria.ANNOTATION_DURATION and DirectionsCriteria.ANNOTATION_CONGESTION

Parameters:

annotations - a list of annotations

Returns:

this builder for chaining options together

addAnnotation

public NbmapDirections.Builder addAnnotation(@NonNull
                                             java.lang.String annotation)

Whether or not to return additional metadata along the route. Possible values are: DirectionsCriteria.ANNOTATION_DISTANCE, DirectionsCriteria.ANNOTATION_DURATION and DirectionsCriteria.ANNOTATION_CONGESTION

Parameters:

annotation - string referencing one of the annotation direction criteria's.

Returns:

this builder for chaining options together

Since:

2.1.0

See Also:

RouteLeg object documentation

addBearing

public NbmapDirections.Builder addBearing(@Nullable
                                          java.lang.Double angle,
                                          @Nullable
                                          java.lang.Double tolerance)

Optionally, Use to filter the road segment the waypoint will be placed on by direction and dictates the angle of approach. This option should always be used in conjunction with the radiuses parameter.

The parameter takes two values per waypoint: the first is an angle clockwise from true north between 0 and 360. The second is the range of degrees the angle can deviate by. We recommend a value of 45 degrees or 90 degrees for the range, as bearing measurements tend to be inaccurate. This is useful for making sure we reroute vehicles on new routes that continue traveling in their current direction. A request that does this would provide bearing and radius values for the first waypoint and leave the remaining values empty. If provided, the list of bearings must be the same length as the list of waypoints, but you can skip a coordinate and show its position by passing in null value for both the angle and tolerance values.

Each bearing value gets associated with the same order which coordinates are arranged in this builder. For example, the first bearing added in this builder will be associated with the origin Point, the nth bearing being associated with the nth waypoint added (if added) and the last bearing being added will be associated with the destination.

Parameters:

angle - double value used for setting the corresponding coordinate's angle of travel when determining the route

tolerance - the deviation the bearing angle can vary while determining the route, recommended to be either 45 or 90 degree tolerance

Returns:

this builder for chaining options together

Since:

2.0.0

bearings

public NbmapDirections.Builder bearings(@NonNull
                                        java.util.List<java.util.List<java.lang.Double>> bearings)

Optionally, Use to filter the road segment the waypoint will be placed on by direction and dictates the angle of approach. This option should always be used in conjunction with the radiuses parameter.

Parameters:

bearings - a list of list of doubles. Every list has two values: the first is an angle clockwise from true north between 0 and 360. The second is the range of degrees the angle can deviate by. We recommend a value of 45 degrees or 90 degrees for the range, as bearing measurements tend to be inaccurate.

Returns:

this builder for chaining options together

radiuses

@Deprecated
public NbmapDirections.Builder radiuses(@NonNull
                                                    java.lang.Double... radiuses)

Deprecated. use radiuses(List)

Optionally, set the maximum distance in meters that each coordinate is allowed to move when snapped to a nearby road segment. There must be as many radiuses as there are coordinates in the request. Values can be any number greater than 0 or they can be unlimited simply by passing Double.POSITIVE_INFINITY.

If no routable road is found within the radius, a NoSegment error is returned.

Parameters:

radiuses - double array containing the radiuses defined in unit meters.

Returns:

this builder for chaining options together

Since:

1.0.0

radiuses

public NbmapDirections.Builder radiuses(@NonNull
                                        java.util.List<java.lang.Double> radiuses)

Optionally, set the maximum distance in meters that each coordinate is allowed to move when snapped to a nearby road segment. There must be as many radiuses as there are coordinates in the request. Values can be any number greater than 0 or they can be unlimited simply by passing Double.POSITIVE_INFINITY.

If no routable road is found within the radius, a NoSegment error is returned.

Parameters:

radiuses - a list with radiuses defined in unit meters.

Returns:

this builder for chaining options together

addRadius

public NbmapDirections.Builder addRadius(@NonNull
                                         java.lang.Double radius)

Optionally, set the maximum distance in meters that each coordinate is allowed to move when snapped to a nearby road segment. There must be as many radiuses as there are coordinates in the request. Values can be any number greater than 0 or they can be unlimited simply by passing Double.POSITIVE_INFINITY.

If no routable road is found within the radius, a NoSegment error is returned.

Parameters:

radius - double param defined in unit meters.

Returns:

this builder for chaining options together

Since:

1.0.0

exclude

public abstract NbmapDirections.Builder exclude(java.lang.String exclude)

Exclude certain road types from routing. Valid values depend on the profile in use. The default is to not exclude anything from the profile selected.

Parameters:

exclude - one of the constants defined in DirectionsCriteria.ExcludeCriteria

Returns:

this builder for chaining options together

Since:

3.0.0

voiceInstructions

public abstract NbmapDirections.Builder voiceInstructions(@Nullable
                                                          java.lang.Boolean voiceInstructions)

Request voice instructions objects to be returned in your response. This offers instructions specific for navigation and provides well spoken text instructions along with the distance from the maneuver the instructions should be said.

It's important to note that the steps(Boolean) should be true or else these results wont be returned.

Parameters:

voiceInstructions - true if you'd like voice instruction objects be attached to your response

Returns:

this builder for chaining options together

Since:

3.0.0

bannerInstructions

public abstract NbmapDirections.Builder bannerInstructions(@Nullable
                                                           java.lang.Boolean bannerInstructions)

Request banner instructions object to be returned in your response. This is useful specifically for navigation and provides an abundance of information one might want to display to their user inside an Android view for example.

Parameters:

bannerInstructions - true if you'd like the receive banner objects within your response object

Returns:

this builder for chaining options together

Since:

3.0.0

voiceUnits

public abstract NbmapDirections.Builder voiceUnits(@Nullable
                                                   java.lang.String voiceUnits)

Specify what unit you'd like voice and banner instructions to use.

Parameters:

voiceUnits - either Imperial (default) or Metric

Returns:

this builder for chaining options together

Since:

3.0.0

clientAppName

public abstract NbmapDirections.Builder clientAppName(@NonNull
                                                      java.lang.String clientAppName)

Base package name or other simple string identifier. Used inside the calls user agent header.

Parameters:

clientAppName - base package name or other simple string identifier

Returns:

this builder for chaining options together

Since:

1.0.0

accessToken

public abstract NbmapDirections.Builder accessToken(@NonNull
                                                    java.lang.String accessToken)

Required to call when this is being built. If no access token provided, ServicesException will be thrown.

Parameters:

accessToken - Nbmap access token, You must have a Nbmap account inorder to use the Optimization API

Returns:

this builder for chaining options together

Since:

2.1.0

baseUrl

public abstract NbmapDirections.Builder baseUrl(java.lang.String baseUrl)

Optionally change the APIs base URL to something other then the default Nbmap one.

Parameters:

baseUrl - base url used as end point

Returns:

this builder for chaining options together

Since:

2.1.0

interceptor

public abstract NbmapDirections.Builder interceptor(okhttp3.Interceptor interceptor)

Adds an optional interceptor to set in the OkHttp client.

Parameters:

interceptor - to set for OkHttp

Returns:

this builder for chaining options together

networkInterceptor

public abstract NbmapDirections.Builder networkInterceptor(okhttp3.Interceptor interceptor)

Adds an optional network interceptor to set in the OkHttp client.

Parameters:

interceptor - to set for OkHttp

Returns:

this builder for chaining options together

eventListener

public abstract NbmapDirections.Builder eventListener(okhttp3.EventListener eventListener)

Adds an optional event listener to set in the OkHttp client.

Parameters:

eventListener - to set for OkHttp

Returns:

this builder for chaining options together

addApproaches

@Deprecated
public NbmapDirections.Builder addApproaches(@NonNull
                                                         java.lang.String... approaches)

Deprecated. use approaches(List)

Indicates from which side of the road to approach a waypoint. Accepts unrestricted (default), curb or null. If set to unrestricted , the route can approach waypoints from either side of the road. If set to curb , the route will be returned so that on arrival, the waypoint will be found on the side that corresponds with the driving_side of the region in which the returned route is located. If provided, the list of approaches must be the same length as the list of waypoints.

Parameters:

approaches - null if you'd like the default approaches, else one of the options found in DirectionsCriteria.ApproachesCriteria.

Returns:

this builder for chaining options together

Since:

3.2.0

approaches

public NbmapDirections.Builder approaches(@NonNull
                                          java.util.List<java.lang.String> approaches)

Indicates from which side of the road to approach a waypoint. Accepts unrestricted (default), curb or null. If set to unrestricted , the route can approach waypoints from either side of the road. If set to curb , the route will be returned so that on arrival, the waypoint will be found on the side that corresponds with the driving_side of the region in which the returned route is located. If provided, the list of approaches must be the same length as the list of waypoints.

Parameters:

approaches - empty if you'd like the default approaches, else one of the options found in DirectionsCriteria.ApproachesCriteria.

Returns:

this builder for chaining options together

addApproach

public NbmapDirections.Builder addApproach(@Nullable
                                           java.lang.String approach)

Indicates from which side of the road to approach a waypoint. Accepts unrestricted (default), curb or null. If set to unrestricted , the route can approach waypoints from either side of the road. If set to curb , the route will be returned so that on arrival, the waypoint will be found on the side that corresponds with the driving_side of the region in which the returned route is located. If provided, the list of approaches must be the same length as the list of waypoints.

Parameters:

approach - null if you'd like the default approaches, else one of the options found in DirectionsCriteria.ApproachesCriteria.

Returns:

this builder for chaining options together

Since:

3.2.0

addWaypointIndices

@Deprecated
public NbmapDirections.Builder addWaypointIndices(@NonNull
                                                              java.lang.Integer... waypointIndices)

Deprecated. use waypointIndices(List)

Optionally, set which input coordinates should be treated as waypoints / separate legs. Note: coordinate indices not added here act as silent waypoints

Most useful in combination with steps=true and requests based on traces with high sample rates. Can be an index corresponding to any of the input coordinates, but must contain the first ( 0 ) and last coordinates' indices. NbmapDirections.steps()

Parameters:

waypointIndices - integer array of coordinate indices to be used as waypoints

Returns:

this builder for chaining options together

Since:

4.4.0

waypointIndices

public NbmapDirections.Builder waypointIndices(@NonNull
                                               java.util.List<java.lang.Integer> waypointIndices)

Optionally, set which input coordinates should be treated as waypoints / separate legs. Note: coordinate indices not added here act as silent waypoints

Most useful in combination with steps=true and requests based on traces with high sample rates. Can be an index corresponding to any of the input coordinates, but must contain the first ( 0 ) and last coordinates' indices. NbmapDirections.steps()

Parameters:

waypointIndices - a list of coordinate indices to be used as waypoints

Returns:

this builder for chaining options together

addWaypointIndex

public NbmapDirections.Builder addWaypointIndex(@NonNull
                                                java.lang.Integer waypointIndex)

Optionally, set which input coordinates should be treated as waypoints / separate legs. Note: coordinate indices not added here act as silent waypoints

Most useful in combination with steps=true and requests based on traces with high sample rates. Can be an index corresponding to any of the input coordinates, but must contain the first ( 0 ) and last coordinates' indices. NbmapDirections.steps()

Parameters:

waypointIndex - integer index to be used as waypoint

Returns:

this builder for chaining options together

Since:

4.4.0

addWaypointNames

@Deprecated
public NbmapDirections.Builder addWaypointNames(@NonNull
                                                            java.lang.String... waypointNames)

Deprecated. use waypointNames(List)

Custom names for waypoints used for the arrival instruction. Values can be any string and total number of all characters cannot exceed 500. If provided, the list of waypointNames must be the same length as the list of coordinates, but you can skip a coordinate and show its position with the null value.

Parameters:

waypointNames - Custom names for waypoints used for the arrival instruction.

Returns:

this builder for chaining options together

Since:

3.3.0

waypointNames

public NbmapDirections.Builder waypointNames(@NonNull
                                             java.util.List<java.lang.String> waypointNames)

Custom names for waypoints used for the arrival instruction. Values can be any string and total number of all characters cannot exceed 500. If provided, the list of waypointNames must be the same length as the list of coordinates, but you can skip a coordinate and show its position with the null value.

Parameters:

waypointNames - a list of custom names for waypoints used for the arrival instruction.

Returns:

this builder for chaining options together

addWaypointName

public NbmapDirections.Builder addWaypointName(@Nullable
                                               java.lang.String waypointName)

Custom names for waypoints used for the arrival instruction. Values can be any string and total number of all characters cannot exceed 500. If provided, the list of waypointNames must be the same length as the list of coordinates, but you can skip a coordinate and show its position with the null value.

Parameters:

waypointName - Custom name for waypoint used for the arrival instruction.

Returns:

this builder for chaining options together

Since:

3.3.0

addWaypointTargets

@Deprecated
public NbmapDirections.Builder addWaypointTargets(@NonNull
                                                              com.nbmap.geojson.Point... waypointTargets)

Deprecated. use waypointTargets(List)

Points to specify drop-off locations that are distinct from the locations specified in coordinates. The number of waypoint targets must be the same as the number of coordinates, but you can skip a coordinate with a null value. Must be used with steps=true.

Parameters:

waypointTargets - list of coordinate points for drop-off locations

Returns:

this builder for chaining options together

Since:

4.3.0

waypointTargets

public NbmapDirections.Builder waypointTargets(@NonNull
                                               java.util.List<com.nbmap.geojson.Point> waypointTargets)

A list of points used to specify drop-off locations that are distinct from the locations specified in coordinates. The number of waypoint targets must be the same as the number of coordinates, but you can skip a coordinate with a null value. Must be used with steps=true.

Parameters:

waypointTargets - list of coordinate points for drop-off locations

Returns:

this builder for chaining options together

addWaypointTarget

public NbmapDirections.Builder addWaypointTarget(@Nullable
                                                 com.nbmap.geojson.Point waypointTarget)

A point to specify drop-off locations that are distinct from the locations specified in coordinates. The number of waypoint targets must be the same as the number of coordinates, but you can skip a coordinate with a null value. Must be used with steps=true.

Parameters:

waypointTarget - a point for drop-off locations

Returns:

this builder for chaining options together

Since:

4.3.0

snappingClosures

public NbmapDirections.Builder snappingClosures(@NonNull
                                                java.util.List<java.lang.Boolean> snappingClosures)

A list of booleans affecting snapping of waypoint locations to road segments. If true, road segments closed due to live-traffic closures will be considered for snapping. If false, they will not be considered for snapping. If provided, the number of snappingClosures must be the same as the number of coordinates. You can skip a coordinate and show its position in the list with null value. Must be used with DirectionsCriteria.PROFILE_DRIVING_TRAFFIC

Parameters:

snappingClosures - a list of booleans

Returns:

this builder for chaining options together

addSnappingClosure

public NbmapDirections.Builder addSnappingClosure(@Nullable
                                                  java.lang.Boolean snappingClosure)

A boolean affecting snapping of waypoint location to the road segment. If true, road segment closed due to live-traffic closure will be considered for snapping. If false, it will not be considered for snapping. If provided, the number of snappingClosures must be the same as the number of coordinates. You can skip a coordinate with null value. Must be used with DirectionsCriteria.PROFILE_DRIVING_TRAFFIC

Parameters:

snappingClosure - a boolean affecting snapping of waypoint location to the road segment.

Returns:

this builder for chaining options together

Since:

5.9.0

enableRefresh

public abstract NbmapDirections.Builder enableRefresh(java.lang.Boolean enableRefresh)

Whether the routes should be refreshable via the directions refresh API.

Parameters:

enableRefresh - whether the routes should be refreshable

Returns:

this builder

Since:

4.4.0

post

public NbmapDirections.Builder post()

Use POST method to request data. The default is to use GET.

Returns:

this builder for chaining options together

Since:

4.6.0

get

public NbmapDirections.Builder get()

Use GET method to request data.

Returns:

this builder for chaining options together

Since:

4.6.0

walkingOptions

public abstract NbmapDirections.Builder walkingOptions(@NonNull
                                                       com.nbmap.api.directions.v5.WalkingOptions walkingOptions)

To be used to specify settings for use with the walking profile.

Parameters:

walkingOptions - options to use for walking profile

Returns:

this builder for chaining options together

Since:

4.8.0

build

public NbmapDirections build()

This uses the provided parameters set using the NbmapDirections.Builder and first checks that all values are valid, formats the values as strings for easier consumption by the API, and lastly creates a new NbmapDirections object with the values provided.

Returns:

a new instance of Nbmap Directions

Since:

2.1.0