com.nbmap.api.matching.v5.models

Class MapMatchingResponse.Builder

java.lang.Object

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

Enclosing class:

MapMatchingResponse

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

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

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract MapMatchingResponse	build() Build a new MapMatchingResponse object.
abstract MapMatchingResponse.Builder	code(java.lang.String code) A string depicting the state of the response.
abstract MapMatchingResponse.Builder	matchings(java.util.List<MapMatchingMatching> matchings) List of MapMatchingMatching objects, essentially a DirectionsWaypoint object with the addition of a confidence value.
abstract MapMatchingResponse.Builder	message(java.lang.String message) Optionally shows up in a map maptching response if an error or something unexpected occurred.
abstract MapMatchingResponse.Builder	tracepoints(java.util.List<MapMatchingTracepoint> tracepoints) A list of MapMatchingTracepoint objects representing the location an input point was matched with.

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 MapMatchingResponse.Builder code(@Nullable
                                                 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.

Parameters:

code - string containing the code

Returns:

this builder for chaining options together

Since:

3.0.0

message

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

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

Parameters:

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

Returns:

this builder for chaining options together

Since:

3.0.0

matchings

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

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

Parameters:

matchings - a list made up of MapMatchingMatching objects

Returns:

this builder for chaining options together

Since:

3.0.0

tracepoints

public abstract MapMatchingResponse.Builder tracepoints(@Nullable
                                                        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.

Parameters:

tracepoints - tracepoints list

Returns:

this builder for chaining options together

Since:

3.0.0

build

public abstract MapMatchingResponse build()

Build a new MapMatchingResponse object.

Returns:

a new MapMatchingResponse using the provided values in this builder

Since:

3.0.0