com.mapbox.api.directions.v5

Class WalkingOptions

java.lang.Object

com.mapbox.api.directions.v5.WalkingOptions

public abstract class WalkingOptions
extends java.lang.Object

Class for specifying options for use with the walking profile.

Since:

4.8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WalkingOptions.Builder This builder is used to create a new object with specifications relating to walking directions.

Constructor Summary

Constructors

Constructor and Description
WalkingOptions()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Double	alleyBias() A bias which determines whether the route should prefer or avoid the use of alleys.
static WalkingOptions.Builder	builder() Build a new WalkingOptions object with no defaults.
static WalkingOptions	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
java.lang.String	toJson() This takes the currently defined values found inside this instance and converts it to a json string.
static com.google.gson.TypeAdapter<WalkingOptions>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.
abstract java.lang.Double	walkingSpeed() Walking speed in meters per second.
abstract 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

WalkingOptions

public WalkingOptions()

Method Detail

walkingSpeed

@SerializedName(value="walking_speed")
 @Nullable
public abstract 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

Returns:

walkingSpeed in meters per second

Since:

4.8.0

walkwayBias

@SerializedName(value="walkway_bias")
 @Nullable
public abstract 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).

Returns:

walkwayBias bias to prefer or avoid walkways

Since:

4.8.0

alleyBias

@SerializedName(value="alley_bias")
 @Nullable
public abstract 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).

Returns:

alleyBias bias to prefer or avoid alleys

Since:

4.8.0

fromJson

public static WalkingOptions fromJson(java.lang.String json)

Create a new instance of this class by passing in a formatted valid JSON String.

Parameters:

json - a formatted valid JSON string defining a WalkingOptions object

Returns:

a new instance of this class defined by the values passed inside this static factory method

Since:

4.8.0

toJson

public final java.lang.String toJson()

This takes the currently defined values found inside this instance and converts it to a json string.

Returns:

a Json string which represents this WalkingOptions object

Since:

4.8.0

typeAdapter

public static com.google.gson.TypeAdapter<WalkingOptions> typeAdapter(com.google.gson.Gson gson)

Gson type adapter for parsing Gson to this class.

Parameters:

gson - the built Gson object

Returns:

the type adapter for this class

Since:

4.8.0

builder

public static WalkingOptions.Builder builder()

Build a new WalkingOptions object with no defaults.

Returns:

a WalkingOptions.Builder object for creating a WalkingOptions object

Since:

4.8.0