com.mapbox.api.directions.v5.models

Class DirectionsWaypoint.Builder

java.lang.Object

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

Enclosing class:

DirectionsWaypoint

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

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

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract DirectionsWaypoint	build() Build a new DirectionsWaypoint object.
abstract DirectionsWaypoint.Builder	distance(java.lang.Double distance) The straight-line distance from the coordinate specified in the query to the location it was snapped to.
abstract DirectionsWaypoint.Builder	name(java.lang.String name) Provides the way name which the waypoint's coordinate is snapped to.
abstract DirectionsWaypoint.Builder	rawLocation(double[] rawLocation) The rawLocation as a double array representing a location snapped to the road network.
T	unrecognizedJsonProperties(java.util.Map<java.lang.String,com.google.gson.JsonElement> unrecognizedProperties) Use this method to add parameters which are not present in the model yet but are supported on the Directions API side in the response.

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

name

@NonNull
public abstract DirectionsWaypoint.Builder name(@NonNull
                                                         java.lang.String name)

Provides the way name which the waypoint's coordinate is snapped to.

Parameters:

name - string with the name of the way the coordinate snapped to

Returns:

this builder for chaining options together

Since:

3.0.0

rawLocation

@NonNull
public abstract DirectionsWaypoint.Builder rawLocation(@NonNull
                                                                double[] rawLocation)

The rawLocation as a double array representing a location snapped to the road network. Once the DirectionsWaypoint objects created, this raw location gets converted into a Point object and is public exposed as such. The double array should have a length of two, index 0 being the longitude and index 1 being latitude.

Parameters:

rawLocation - a double array with a length of two, index 0 being the longitude and index 1 being latitude.

Returns:

this builder for chaining options together

Since:

3.0.0

distance

@NonNull
public abstract DirectionsWaypoint.Builder distance(@Nullable
                                                             java.lang.Double distance)

The straight-line distance from the coordinate specified in the query to the location it was snapped to.

Parameters:

distance - distance from original requested location

build

public abstract DirectionsWaypoint build()

Build a new DirectionsWaypoint object.

Returns:

a new DirectionsWaypoint using the provided values in this builder

Since:

3.0.0

unrecognizedJsonProperties

@NonNull
public T unrecognizedJsonProperties(@Nullable
                                             java.util.Map<java.lang.String,com.google.gson.JsonElement> unrecognizedProperties)

Use this method to add parameters which are not present in the model yet but are supported on the Directions API side in the response. Use it for experimental parameters.

Parameters:

unrecognizedProperties - parameters to add to request