com.mapbox.api.directions.v5.models

Class DirectionsError.Builder

java.lang.Object

com.mapbox.api.directions.v5.models.DirectionsError.Builder

Enclosing class:

DirectionsError

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

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

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract DirectionsError	build() Build a new DirectionsError object.
abstract DirectionsError.Builder	code(java.lang.String code) String indicating the state of the response.
abstract DirectionsError.Builder	message(java.lang.String message) Provides a short message with the explanation of the invalid input.

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 DirectionsError.Builder code(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. The possible responses are listed below:

• Ok:200 Normal success case
• NoRoute: 200 There was no route found for the given coordinates. Check for impossible routes (e.g. routes over oceans without ferry connections).
• NoSegment: 200 No road segment could be matched for coordinates. Check for coordinates too far away from a road.
• ProfileNotFound: 404 Use a valid profile as described above
• InvalidInput: 422

Parameters:

code - a string with one of the given values described in the list above

Returns:

this builder for chaining options together

Since:

3.0.0

message

public abstract DirectionsError.Builder message(java.lang.String message)

Provides a short message with the explanation of the invalid input.

Parameters:

message - a string containing the message API Directions response

Returns:

this builder for chaining options together

Since:

3.0.0

build

public abstract DirectionsError build()

Build a new DirectionsError object.

Returns:

a new DirectionsError using the provided values in this builder

Since:

3.0.0