com.nbmap.api.matching.v5.models

Class MapMatchingResponse

java.lang.Object

com.nbmap.api.matching.v5.models.MapMatchingResponse

All Implemented Interfaces:

java.io.Serializable

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

Nbmap map matching API response and convenience getter methods for optional properties.

Since:

2.0.0

See Also:

Map Matching API Documentation, Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
MapMatchingResponse()

Method Summary

Modifier and Type	Method and Description
static MapMatchingResponse.Builder	builder() Create a new instance of this class by using the MapMatchingResponse.Builder class.
abstract java.lang.String	code() A string depicting the state of the response.
static MapMatchingResponse	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract java.util.List<MapMatchingMatching>	matchings() List of MapMatchingMatching objects, essentially a DirectionsWaypoint object with the addition of a confidence value.
abstract java.lang.String	message() Optionally shows up in a directions response if an error or something unexpected occurred.
abstract MapMatchingResponse.Builder	toBuilder() Convert the current MapMatchingResponse to its builder holding the currently assigned values.
abstract java.util.List<MapMatchingTracepoint>	tracepoints() A list of MapMatchingTracepoint objects representing the location an input point was matched with.
static com.google.gson.TypeAdapter<MapMatchingResponse>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapMatchingResponse

public MapMatchingResponse()

Method Detail

builder

public static MapMatchingResponse.Builder builder()

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

Returns:

this classes MapMatchingResponse.Builder for creating a new instance

Since:

3.0.0

code

@NonNull
public abstract java.lang.String code()

A string depicting the state of the response.

• "Ok" - Normal case
• "NoMatch" - The input did not produce any matches. matchings will be an empty array.
• "TooManyCoordinates" - There are more than 100 points in the request.
• "InvalidInput" - message will hold an explanation of the invalid input.
• "ProfileNotFound" - Profile should be nbmap.driving, nbmap.walking, or nbmap.cycling.

Returns:

string containing the code

Since:

2.0.0

message

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

Optionally shows up in a directions response if an error or something unexpected occurred.

Returns:

a string containing the message API MapMatching response with if an error occurred

Since:

3.0.0

matchings

@Nullable
public abstract java.util.List<MapMatchingMatching> matchings()

List of MapMatchingMatching objects, essentially a DirectionsWaypoint object with the addition of a confidence value.

Returns:

a list made up of MapMatchingMatching objects

Since:

2.0.0

tracepoints

@Nullable
public abstract java.util.List<MapMatchingTracepoint> tracepoints()

A list of MapMatchingTracepoint objects representing the location an input point was matched with. list of Waypoint objects representing all input points of the trace in the order they were matched. If a trace point is omitted by map matching because it is an outlier, the entry will be null.

Returns:

tracepoints list

Since:

2.0.0

toBuilder

public abstract MapMatchingResponse.Builder toBuilder()

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

Returns:

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

Since:

3.0.0

typeAdapter

public static com.google.gson.TypeAdapter<MapMatchingResponse> 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 MapMatchingResponse 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 GeoJson Map Matching response

Returns:

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

Since:

3.4.0