com.mapbox.api.matrix.v1.models

Class MatrixResponse

java.lang.Object

com.mapbox.api.matrix.v1.models.MatrixResponse

All Implemented Interfaces:

java.io.Serializable

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

This contains the Matrix API response information which can be used to display the results.

Since:

2.1.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
MatrixResponse()

Method Summary

Modifier and Type	Method and Description
static MatrixResponse.Builder	builder() Create a new instance of this class using the MatrixResponse.Builder which provides a to pass in variables which define the instance.
abstract java.lang.String	code() String indicating the state of the response.
abstract java.util.List<com.mapbox.api.directions.v5.models.DirectionsWaypoint>	destinations() List of DirectionsWaypoint objects.
abstract java.util.List<java.lang.Double[]>	distances() Distances as a list of arrays representing the matrix in row-major order.
abstract java.util.List<java.lang.Double[]>	durations() Durations as a list of arrays representing the matrix in row-major order.
abstract java.util.List<com.mapbox.api.directions.v5.models.DirectionsWaypoint>	sources() List of DirectionsWaypoint objects.
abstract MatrixResponse.Builder	toBuilder() Convert the current MatrixResponse to its builder holding the currently assigned values.
static com.google.gson.TypeAdapter<MatrixResponse>	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

MatrixResponse

public MatrixResponse()

Method Detail

builder

public static MatrixResponse.Builder builder()

Create a new instance of this class using the MatrixResponse.Builder which provides a to pass in variables which define the instance.

Returns:

this classes MatrixResponse.Builder for creating a new instance

Since:

3.0.0

code

@NonNull
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.

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.

Returns:

"Ok", "NoRoute", "ProfileNotFound", or "InvalidInput"

Since:

2.1.0

destinations

@Nullable
public abstract java.util.List<com.mapbox.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.

Returns:

list object with each item being a DirectionsWaypoint

Since:

2.1.0

sources

@Nullable
public abstract java.util.List<com.mapbox.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.

Returns:

list object with each item being a DirectionsWaypoint

Since:

2.1.0

durations

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

Durations as a list 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.

Returns:

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

Since:

2.1.0

distances

@Nullable
public abstract 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.

Returns:

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

Since:

4.1.0

toBuilder

public abstract MatrixResponse.Builder toBuilder()

Convert the current MatrixResponse to its builder holding the currently assigned values. This allows you to modify a single variable and then rebuild the object resulting in an updated and modified MatrixResponse.

Returns:

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

Since:

3.1.0

typeAdapter

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