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

Class DirectionsWaypoint

java.lang.Object

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

Direct Known Subclasses:

MapMatchingTracepoint, OptimizationWaypoint

public class DirectionsWaypoint
extends java.lang.Object

An input coordinate snapped to the roads network.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
DirectionsWaypoint() Empty constructor

Method Summary

Modifier and Type	Method and Description
com.mapbox.services.commons.models.Position	asPosition() Converts double array getLocation() to a Position.
double[]	getLocation() an array with two double values representing the maneuver locations coordinate.
java.lang.String	getName() Provides the way name which the waypoint's coordinate is snapped to.
void	setLocation(double[] location) Sets double array of [longitude, latitude] for the snapped coordinate.
void	setName(java.lang.String name) Provide a way name which the waypoint's coordinate is snapped to.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectionsWaypoint

public DirectionsWaypoint()

Empty constructor

Since:

2.0.0

Method Detail

getName

public java.lang.String getName()

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

Returns:

String with the name of the way the coordinate snapped to.

Since:

1.0.0

setName

public void setName(java.lang.String name)

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

Parameters:

name - a String with the name of the way the coordinate snapped to.

Since:

2.1.0

getLocation

public double[] getLocation()

an array with two double values representing the maneuver locations coordinate.

Returns:

double array of [longitude, latitude] for the snapped coordinate.

Since:

1.0.0

setLocation

public void setLocation(double[] location)

Sets double array of [longitude, latitude] for the snapped coordinate.

Parameters:

location - array with the order [longitude, latitude].

Since:

2.1.0

asPosition

public com.mapbox.services.commons.models.Position asPosition()

Converts double array getLocation() to a Position. You'll typically want to use this format instead of getLocation() as it's easier to work with.

Returns:

Position.

Since:

1.0.0