com.mapbox.services.api.directionsmatrix.v1.models

Class DirectionsMatrixResponse

java.lang.Object

com.mapbox.services.api.directionsmatrix.v1.models.DirectionsMatrixResponse

public class DirectionsMatrixResponse
extends java.lang.Object

The Directions Matrix API response providing getters and setters for all response parameters.

Since:

2.1.0

Constructor Summary

Constructors

Constructor and Description
DirectionsMatrixResponse() Empty constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode() String indicating the state of the response.
java.util.List<DirectionsWaypoint>	getDestinations() List of DirectionsWaypoint objects.
double[][]	getDurations() Durations as array of arrays representing the matrix in row-major order.
java.util.List<DirectionsWaypoint>	getSources() List of DirectionsWaypoint objects.
void	setCode(java.lang.String code) String indicating the state of the response.
void	setDestinations(java.util.List<DirectionsWaypoint> destinations) List of DirectionsWaypoint objects.
void	setDurations(double[][] durations) Durations as array of arrays representing the matrix in row-major order.
void	setSources(java.util.List<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

DirectionsMatrixResponse

public DirectionsMatrixResponse()

Empty constructor

Since:

2.1.0

Method Detail

getCode

public java.lang.String getCode()

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.

Returns:

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

Since:

2.1.0

setCode

public void setCode(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.

Parameters:

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

Since:

2.1.0

getDurations

public double[][] getDurations()

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.

Returns:

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

Since:

2.1.0

setDurations

public void setDurations(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 should always 0.

Parameters:

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

Since:

2.1.0

getDestinations

public java.util.List<DirectionsWaypoint> getDestinations()

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 destinations query parameter.

Returns:

List object with each item being a DirectionsWaypoint.

Since:

2.1.0

setDestinations

public void setDestinations(java.util.List<DirectionsWaypoint> destinations)

List of DirectionsWaypoint objects. Each waypoints should be 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.

Since:

2.1.0

getSources

public java.util.List<DirectionsWaypoint> getSources()

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

setSources

public void setSources(java.util.List<DirectionsWaypoint> sources)

List of DirectionsWaypoint objects. Each waypoints should be 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.

Since:

2.1.0