com.mapbox.api.directions.v5.models

Class IntersectionLanes

java.lang.Object

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

com.mapbox.api.directions.v5.models.IntersectionLanes

All Implemented Interfaces:

java.io.Serializable

public abstract class IntersectionLanes
extends DirectionsJsonObject

Object representing lanes in an intersection.

Since:

2.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
IntersectionLanes()

Method Summary

Modifier and Type	Method and Description
abstract IntersectionLaneAccess	access() A IntersectionLaneAccess object representing the access attributes of the lane.
abstract java.lang.Boolean	active() Indicates whether this lane is a preferred lane (true) or not (false).
static IntersectionLanes.Builder	builder() Create a new instance of this class by using the IntersectionLanes.Builder class.
static IntersectionLanes	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract java.util.List<java.lang.String>	indications() Array that can be made up of multiple signs such as left, right, etc.
abstract java.util.List<java.lang.String>	paymentMethods() Available payment methods for the lane.
abstract IntersectionLanes.Builder	toBuilder() Convert the current IntersectionLanes to its builder holding the currently assigned values.
static com.google.gson.TypeAdapter<IntersectionLanes>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.
abstract java.lang.Boolean	valid() Provides a boolean value you can use to determine if the given lane is valid for the user to complete the maneuver.
abstract java.lang.String	validIndication() When either valid or active is set to true, this property shows which of the lane indications is applicable to the current route, when there is more than one.

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

IntersectionLanes

public IntersectionLanes()

Method Detail

builder

public static IntersectionLanes.Builder builder()

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

Returns:

this classes IntersectionLanes.Builder for creating a new instance

Since:

3.0.0

valid

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

Provides a boolean value you can use to determine if the given lane is valid for the user to complete the maneuver.

Returns:

Boolean value for whether this lane can be taken to complete the maneuver. For instance, if the lane array has four objects and the first two are marked as valid, then the driver can take either of the left lanes and stay on the route.

Since:

2.0.0

active

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

Indicates whether this lane is a preferred lane (true) or not (false). A preferred lane is a lane that is recommended if there are multiple lanes available. For example, if guidance indicates that the driver must turn left at an intersection and there are multiple left turn lanes, the left turn lane that will better prepare the driver for the next maneuver will be marked as active. Only available on the mapbox/driving profile.

Returns:

Indicates whether this lane is a preferred lane (true) or not (false).

validIndication

@Nullable
 @SerializedName(value="valid_indication")
public abstract java.lang.String validIndication()

When either valid or active is set to true, this property shows which of the lane indications is applicable to the current route, when there is more than one. For example, if a lane allows you to go left or straight but your current route is guiding you to the left, then this value will be set to left. See indications for possible values. When both active and valid are false, this property will not be included in the response. Only available on the mapbox/driving profile.

Returns:

which of the lane indications is applicable to the current route, when there is more than one

indications

@Nullable
public abstract java.util.List<java.lang.String> indications()

Array that can be made up of multiple signs such as left, right, etc.

Returns:

List of signs for each turn lane. There can be multiple signs. For example, a turning lane can have a sign with an arrow pointing left and another sign with an arrow pointing straight.

Since:

2.0.0

paymentMethods

@Nullable
 @SerializedName(value="payment_methods")
public abstract java.util.List<java.lang.String> paymentMethods()

Available payment methods for the lane.

Returns:

A list of strings where each value matches DirectionsCriteria.PaymentMethodsCriteria

access

@Nullable
 @SerializedName(value="access")
public abstract IntersectionLaneAccess access()

A IntersectionLaneAccess object representing the access attributes of the lane. This can include information such as the vehicle types for which the lane is designated.

Returns:

an object representing the access attributes of the lane.

toBuilder

public abstract IntersectionLanes.Builder toBuilder()

Convert the current IntersectionLanes 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 IntersectionLanes.

Returns:

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

Since:

3.1.0

typeAdapter

public static com.google.gson.TypeAdapter<IntersectionLanes> 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 IntersectionLanes 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 an IntersectionLanes

Returns:

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

Since:

3.4.0