com.mapbox.api.directions.v5

Class WalkingOptions.Builder

java.lang.Object

com.mapbox.api.directions.v5.WalkingOptions.Builder

Enclosing class:

WalkingOptions

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

This builder is used to create a new object with specifications relating to walking directions.

Since:

4.8.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract WalkingOptions.Builder	alleyBias(java.lang.Double alleyBias) A bias which determines whether the route should prefer or avoid the use of alleys.
abstract WalkingOptions	build() Builds a WalkingOptions object with specified configurations.
abstract WalkingOptions.Builder	walkingSpeed(java.lang.Double walkingSpeed) Walking speed in meters per second.
abstract WalkingOptions.Builder	walkwayBias(java.lang.Double walkwayBias) A bias which determines whether the route should prefer or avoid the use of roads or paths that are set aside for pedestrian-only use (walkways).

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

walkingSpeed

public abstract WalkingOptions.Builder walkingSpeed(@Nullable
                                                    java.lang.Double walkingSpeed)

Walking speed in meters per second. Must be between 0.14 and 6.94 meters per second. Defaults to 1.42 meters per second

Parameters:

walkingSpeed - in meters per second

Returns:

this builder

Since:

4.8.0

walkwayBias

public abstract WalkingOptions.Builder walkwayBias(@Nullable
                                                   java.lang.Double walkwayBias)

A bias which determines whether the route should prefer or avoid the use of roads or paths that are set aside for pedestrian-only use (walkways). The allowed range of values is from -1 to 1, where -1 indicates indicates preference to avoid walkways, 1 indicates preference to favor walkways, and 0 indicates no preference (the default).

Parameters:

walkwayBias - bias to prefer or avoid walkways

Returns:

this builder

Since:

4.8.0

alleyBias

public abstract WalkingOptions.Builder alleyBias(@Nullable
                                                 java.lang.Double alleyBias)

A bias which determines whether the route should prefer or avoid the use of alleys. The allowed range of values is from -1 to 1, where -1 indicates indicates preference to avoid alleys, 1 indicates preference to favor alleys, and 0 indicates no preference (the default).

Parameters:

alleyBias - bias to prefer or avoid alleys

Returns:

this builder

Since:

4.8.0

build

public abstract WalkingOptions build()

Builds a WalkingOptions object with specified configurations.

Returns:

WalkingOptions object

Since:

4.8.0