com.mapbox.api.matching.v5.models

Class MapMatchingTracepoint

java.lang.Object

com.mapbox.api.matching.v5.models.MapMatchingTracepoint

All Implemented Interfaces:

java.io.Serializable

public abstract class MapMatchingTracepoint
extends java.lang.Object
implements java.io.Serializable

A tracepoint object is DirectionsWaypoint object with two additional fields.

Since:

2.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
MapMatchingTracepoint()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Integer	alternativesCount() Number of probable alternative matchings for this trace point.
static MapMatchingTracepoint.Builder	builder() Create a new instance of this class by using the MapMatchingTracepoint.Builder class.
com.mapbox.geojson.Point	location() A Point representing this waypoint location.
abstract java.lang.Integer	matchingsIndex() Index to the match object in matchings the sub-trace was matched to.
abstract java.lang.String	name() Provides the way name which the waypoint's coordinate is snapped to.
abstract MapMatchingTracepoint.Builder	toBuilder() Convert the current MapMatchingTracepoint to its builder holding the currently assigned values.
static com.google.gson.TypeAdapter<MapMatchingTracepoint>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.
abstract java.lang.Integer	waypointIndex() Index of the waypoint inside the matched route.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapMatchingTracepoint

public MapMatchingTracepoint()

Method Detail

builder

public static MapMatchingTracepoint.Builder builder()

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

Returns:

this classes MapMatchingTracepoint.Builder for creating a new instance

Since:

3.0.0

matchingsIndex

@Nullable
 @SerializedName(value="matchings_index")
public abstract java.lang.Integer matchingsIndex()

Index to the match object in matchings the sub-trace was matched to.

Returns:

index value

Since:

2.2.0

alternativesCount

@Nullable
 @SerializedName(value="alternatives_count")
public abstract java.lang.Integer alternativesCount()

Number of probable alternative matchings for this trace point. A value of zero indicates that this point was matched unambiguously. Split the trace at these points for incremental map matching.

Returns:

an integer representing the alternatives count

Since:

2.2.0

waypointIndex

@Nullable
 @SerializedName(value="waypoint_index")
public abstract java.lang.Integer waypointIndex()

Index of the waypoint inside the matched route.

Returns:

index value

Since:

2.2.0

location

@Nullable
public com.mapbox.geojson.Point location()

A Point representing this waypoint location.

Returns:

GeoJson Point representing this waypoint location

Since:

3.0.0

name

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

Provides the way name which the waypoint's coordinate is snapped to.

Returns:

string with the name of the way the coordinate snapped to

Since:

1.0.0

toBuilder

public abstract MapMatchingTracepoint.Builder toBuilder()

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

Returns:

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

Since:

3.1.0

typeAdapter

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