com.nbmap.api.matching.v5.models

Class MapMatchingError.Builder

java.lang.Object

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

Enclosing class:

MapMatchingError

public abstract static class MapMatchingError.Builder
extends java.lang.Object

This builder can be used to set the values describing the MapMatchingError.

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract MapMatchingError	build() Build a new MapMatchingError object.
abstract MapMatchingError.Builder	code(java.lang.String code) String indicating the state of the response.
abstract MapMatchingError.Builder	message(java.lang.String message) Provides a short message with the explanation of the invalid input.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

code

public abstract MapMatchingError.Builder code(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.

Parameters:

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

Returns:

this builder for chaining options together

Since:

3.0.0

message

public abstract MapMatchingError.Builder message(java.lang.String message)

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

Parameters:

message - a string containing the message API Directions response

Returns:

this builder for chaining options together

Since:

3.0.0

build

public abstract MapMatchingError build()

Build a new MapMatchingError object.

Returns:

a new MapMatchingError using the provided values in this builder

Since:

3.0.0