com.nbmap.api.matching.v5.models

Class MapMatchingError

java.lang.Object

com.nbmap.api.matching.v5.models.MapMatchingError

All Implemented Interfaces:

java.io.Serializable

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

If an InvalidInput error is thrown, this class can be used to get both the code and the message which holds an explanation of the invalid input. On error, the server responds with different HTTP status codes. For responses with HTTP status codes lower than 500, the JSON response body includes the code property, which may be used by client programs to manage control flow. The response body may also include a message property, with a human-readable explaination of the error. If a server error occurs, the HTTP status code will be 500 or higher and the response will not include a code property.

Since:

3.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
MapMatchingError()

Method Summary

Modifier and Type	Method and Description
static MapMatchingError.Builder	builder() Create a new instance of this class by using the MapMatchingError.Builder class.
abstract java.lang.String	code() String indicating the state of the response.
abstract java.lang.String	message() Provides a short message with the explanation of the invalid input.
static com.google.gson.TypeAdapter<MapMatchingError>	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

MapMatchingError

public MapMatchingError()

Method Detail

builder

public static MapMatchingError.Builder builder()

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

Returns:

this classes MapMatchingError.Builder for creating a new instance

Since:

3.0.0

code

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

String indicating the state of the response. This is a separate code than the HTTP status code. On normal valid responses, the value will be Ok. The possible responses are listed below:

• Ok Normal case.
• NoMatch The input did not produce any matches, or the waypoints requested were not found in the resulting match. features will be an empty array.
• TooManyCoordinates There are more than 100 points in the request.
• ProfileNotFound Needs to be a valid profile.
• InvalidInputmessage will hold an explanation of the invalid input.

Returns:

a string with one of the given values described in the list above

Since:

3.0.0

message

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

Provides a short message with the explanation of the invalid input.

Returns:

a string containing the message API MapMatching response

Since:

3.0.0

typeAdapter

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