com.nbmap.api.directions.v5.models

Class DirectionsError

java.lang.Object

com.nbmap.api.directions.v5.models.DirectionsError

All Implemented Interfaces:

java.io.Serializable

public abstract class DirectionsError
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.

Since:

3.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
DirectionsError()

Method Summary

Modifier and Type	Method and Description
static DirectionsError.Builder	builder() Create a new instance of this class by using the DirectionsError.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.
abstract DirectionsError.Builder	toBuilder() Convert the current DirectionsError to its builder holding the currently assigned values.
static com.google.gson.TypeAdapter<DirectionsError>	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

DirectionsError

public DirectionsError()

Method Detail

builder

public static DirectionsError.Builder builder()

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

Returns:

this classes DirectionsError.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:200 Normal success case
• NoRoute: 200 There was no route found for the given coordinates. Check for impossible routes (e.g. routes over oceans without ferry connections).
• NoSegment: 200 No road segment could be matched for coordinates. Check for coordinates too far away from a road.
• ProfileNotFound: 404 Use a valid profile as described above
• InvalidInput: 422

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 Directions response

Since:

3.0.0

toBuilder

public abstract DirectionsError.Builder toBuilder()

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

Returns:

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

Since:

3.1.0

typeAdapter

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