com.mapbox.api.directions.v5.models

Class MaxSpeed

java.lang.Object

com.mapbox.api.directions.v5.models.DirectionsJsonObject

com.mapbox.api.directions.v5.models.MaxSpeed

All Implemented Interfaces:

java.io.Serializable

public abstract class MaxSpeed
extends DirectionsJsonObject

Object representing max speeds along a route.

Since:

3.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MaxSpeed.Builder This builder can be used to set the values describing the MaxSpeed.

Constructor Summary

Constructors

Constructor and Description
MaxSpeed()

Method Summary

Modifier and Type	Method and Description
static MaxSpeed.Builder	builder() Create a new instance of this class by using the MaxSpeed.Builder class.
static MaxSpeed	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract java.lang.Boolean	none() Boolean is `true` if the speed limit is unlimited, otherwise null.
abstract java.lang.Integer	speed() Number indicating the posted speed limit.
abstract MaxSpeed.Builder	toBuilder() Convert the current MaxSpeed to its builder holding the currently assigned values.
static com.google.gson.TypeAdapter<MaxSpeed>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.
abstract java.lang.String	unit() String indicating the unit of speed, either as `km/h` or `mph`.
abstract java.lang.Boolean	unknown() Boolean is true if the speed limit is not known, otherwise null.

Methods inherited from class com.mapbox.api.directions.v5.models.DirectionsJsonObject

getUnrecognizedJsonProperties, getUnrecognizedPropertiesNames, getUnrecognizedProperty, toJson

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MaxSpeed

public MaxSpeed()

Method Detail

builder

public static MaxSpeed.Builder builder()

Create a new instance of this class by using the MaxSpeed.Builder class.

Returns:

MaxSpeed.Builder for creating a new instance

Since:

3.0.0

speed

@Nullable
public abstract java.lang.Integer speed()

Number indicating the posted speed limit.

Returns:

number indicating the posted speed limit

Since:

3.0.0

unit

@Nullable
public abstract java.lang.String unit()

String indicating the unit of speed, either as `km/h` or `mph`.

Returns:

String unit either as `km/h` or `mph`

Since:

3.0.0

unknown

@Nullable
public abstract java.lang.Boolean unknown()

Boolean is true if the speed limit is not known, otherwise null.

Returns:

Boolean true if speed limit is not known, otherwise null

Since:

3.0.0

none

@Nullable
public abstract java.lang.Boolean none()

Boolean is `true` if the speed limit is unlimited, otherwise null.

Returns:

Boolean true if speed limit is unlimited, otherwise null

Since:

3.0.0

toBuilder

public abstract MaxSpeed.Builder toBuilder()

Convert the current MaxSpeed to its builder holding the currently assigned values. This allows you to modify a single property and then rebuild the object resulting in an updated and modified MaxSpeed.

Returns:

a MaxSpeed.Builder with the same values set to match the ones defined in this MaxSpeed

Since:

3.1.0

typeAdapter

public static com.google.gson.TypeAdapter<MaxSpeed> 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:

3.0.0

fromJson

public static MaxSpeed 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 MaxSpeed

Returns:

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

Since:

3.4.0