com.mapbox.services.api.directions.v5.models

Class DirectionsResponse

java.lang.Object

com.mapbox.services.api.directions.v5.models.DirectionsResponse

public class DirectionsResponse
extends java.lang.Object

The response to a directions request.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
DirectionsResponse() Empty constructor
DirectionsResponse(java.util.List<DirectionsRoute> routes, java.util.List<DirectionsWaypoint> waypoints) Constructor taking in both a list of DirectionsRoute and a list of DirectionsWaypoints.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode() String indicating the state of the response.
java.util.List<DirectionsRoute>	getRoutes() List containing all the different route options.
java.util.List<DirectionsWaypoint>	getWaypoints() List with Waypoints of locations snapped to the road and path network and appear in the List in the order of the input coordinates.
void	setCode(java.lang.String code) String indicating the state of the response.
void	setRoutes(java.util.List<DirectionsRoute> routes) List containing all the different route options.
void	setWaypoints(java.util.List<DirectionsWaypoint> waypoints) List with Waypoints of locations snapped to the road and path network and should appear in the List in the order of the input coordinates.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectionsResponse

public DirectionsResponse()

Empty constructor

Since:

2.1.0

DirectionsResponse

public DirectionsResponse(java.util.List<DirectionsRoute> routes,
                          java.util.List<DirectionsWaypoint> waypoints)

Constructor taking in both a list of DirectionsRoute and a list of DirectionsWaypoints.

Parameters:

routes - list of routes you can pass in while building this object.

waypoints - list of waypoints you can pass in while building this object. Ideally these should match what was used to crate the route.

Since:

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

Returns:

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

Since:

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

Parameters:

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

Since:

2.1.0

getWaypoints

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

List with Waypoints of locations snapped to the road and path network and appear in the List in the order of the input coordinates.

Returns:

List of DirectionsWaypoint objects.

Since:

1.0.0

setWaypoints

public void setWaypoints(java.util.List<DirectionsWaypoint> waypoints)

List with Waypoints of locations snapped to the road and path network and should appear in the List in the order of the input coordinates.

Parameters:

waypoints - List of DirectionsWaypoint objects.

Since:

2.1.0

getRoutes

public java.util.List<DirectionsRoute> getRoutes()

List containing all the different route options. It's ordered by descending recommendation rank. In other words, object 0 in the List is the highest recommended route. if you don't setAlternatives to true (default is false) in your builder this should always be a List of size 1.

Returns:

List of DirectionsRoute objects.

Since:

1.0.0

setRoutes

public void setRoutes(java.util.List<DirectionsRoute> routes)

List containing all the different route options. It should be ordered by descending recommendation rank. In other words, object 0 in the List is the highest recommended route. if you don't setAlternatives to true (default is false) in your builder this should always be a List of size 1.

Parameters:

routes - List of DirectionsRoute objects.

Since:

2.1.0