com.nbmap.api.matrix.v1.models

Class MatrixResponse.Builder

java.lang.Object

com.nbmap.api.matrix.v1.models.MatrixResponse.Builder

Enclosing class:

MatrixResponse

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

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

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract MatrixResponse	build() Build a new MatrixResponse object.
abstract MatrixResponse.Builder	code(java.lang.String code) String indicating the state of the response.
abstract MatrixResponse.Builder	destinations(java.util.List<com.nbmap.api.directions.v5.models.DirectionsWaypoint> destinations) List of DirectionsWaypoint objects.
abstract MatrixResponse.Builder	distances(java.util.List<java.lang.Double[]> distances) Distances as a list of arrays representing the matrix in row-major order.
abstract MatrixResponse.Builder	durations(java.util.List<java.lang.Double[]> durations) Durations as array of arrays representing the matrix in row-major order.
abstract MatrixResponse.Builder	sources(java.util.List<com.nbmap.api.directions.v5.models.DirectionsWaypoint> sources) List of DirectionsWaypoint objects.

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 MatrixResponse.Builder code(@NonNull
                                            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.

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 explanation 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.

Note that in cases where no route is found between a source and destination, no error will be returned, but instead the respective value in the durations matrix will be null.

Parameters:

code - "Ok", "NoRoute", "ProfileNotFound", or "InvalidInput"

Returns:

this builder for chaining options together

Since:

2.1.0

destinations

public abstract MatrixResponse.Builder destinations(@Nullable
                                                    java.util.List<com.nbmap.api.directions.v5.models.DirectionsWaypoint> destinations)

List of DirectionsWaypoint objects. Each waypoint is an input coordinate snapped to the road and path network. The waypoints appear in the list in the order of the input coordinates, or in the order as specified in the destinations query parameter.

Parameters:

destinations - list object with each item being a DirectionsWaypoint

Returns:

this builder for chaining options together

Since:

2.1.0

sources

public abstract MatrixResponse.Builder sources(@Nullable
                                               java.util.List<com.nbmap.api.directions.v5.models.DirectionsWaypoint> sources)

List of DirectionsWaypoint objects. Each waypoints is an input coordinate snapped to the road and path network. The waypoints appear in the list in the order of the input coordinates, or in the order as specified in the sources query parameter.

Parameters:

sources - list object with each item being a DirectionsWaypoint

Returns:

this builder for chaining options together

Since:

2.1.0

durations

public abstract MatrixResponse.Builder durations(@Nullable
                                                 java.util.List<java.lang.Double[]> durations)

Durations as array of arrays representing the matrix in row-major order. durations[i][j] gives the travel time from the i-th source to the j-th destination. All values are in seconds. The duration between the same coordinate is always 0. If a duration can not be found, the result is null.

Parameters:

durations - an array of array with each entry being a duration value given in seconds.

Returns:

this builder for chaining options together

Since:

2.1.0

distances

public abstract MatrixResponse.Builder distances(@Nullable
                                                 java.util.List<java.lang.Double[]> distances)

Distances as a list of arrays representing the matrix in row-major order. distances[i][j] gives the travel distance from the i-th source to the j-th destination. All values are in meters. The duration between the same coordinate is always 0. If a distance can not be found, the result is null.

Parameters:

distances - an array of array with each entry being a distance value given in meters

Returns:

this builder for chaining options together

Since:

4.1.0

build

public abstract MatrixResponse build()

Build a new MatrixResponse object.

Returns:

a new MatrixResponse using the provided values in this builder

Since:

3.0.0