com.mapbox.api.directions.v5.models

Class MergingArea

java.lang.Object

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

com.mapbox.api.directions.v5.models.MergingArea

All Implemented Interfaces:

java.io.Serializable

public abstract class MergingArea
extends DirectionsJsonObject

Class containing information about merging area, i.e. an area where traffic is being merged into the current road.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MergingArea.Builder This builder can be used to set the values describing the MergingArea.
static interface	MergingArea.Type Merging Area type.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_FROM_BOTH_SIDES MergingArea.Type value meaning that traffic is being merged into current road from both sides.
static java.lang.String	TYPE_FROM_LEFT MergingArea.Type value meaning that traffic is being merged into current road from the left side.
static java.lang.String	TYPE_FROM_RIGHT MergingArea.Type value meaning that traffic is being merged into current road from the right side.

Constructor Summary

Constructors

Constructor and Description
MergingArea()

Method Summary

Modifier and Type	Method and Description
static MergingArea.Builder	builder() Create a new instance of this class by using the MergingArea.Builder class.
static MergingArea	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract MergingArea.Builder	toBuilder() Convert the current MergingArea to its builder holding the currently assigned values.
abstract java.lang.String	type() Type of the merging area.
static com.google.gson.TypeAdapter<MergingArea>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.

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

Field Detail

TYPE_FROM_LEFT

public static final java.lang.String TYPE_FROM_LEFT

MergingArea.Type value meaning that traffic is being merged into current road from the left side.

See Also:

Constant Field Values

TYPE_FROM_RIGHT

public static final java.lang.String TYPE_FROM_RIGHT

MergingArea.Type value meaning that traffic is being merged into current road from the right side.

See Also:

Constant Field Values

TYPE_FROM_BOTH_SIDES

public static final java.lang.String TYPE_FROM_BOTH_SIDES

MergingArea.Type value meaning that traffic is being merged into current road from both sides.

See Also:

Constant Field Values

Constructor Detail

MergingArea

public MergingArea()

Method Detail

type

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

Type of the merging area. See MergingArea.Type for possible values.

Returns:

type of the merging area.

builder

public static MergingArea.Builder builder()

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

Returns:

this classes MergingArea.Builder for creating a new instance

toBuilder

public abstract MergingArea.Builder toBuilder()

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

Returns:

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

typeAdapter

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

fromJson

public static MergingArea 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 Merging Area

Returns:

a new instance of this class defined by the values passed in the method