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

Class RouteLeg

java.lang.Object

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

public class RouteLeg
extends java.lang.Object

A route between only two DirectionsWaypoint.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
RouteLeg() Empty constructor

Method Summary

Modifier and Type	Method and Description
LegAnnotation	getAnnotation() An LegAnnotation that contains additional details about each line segment along the route geometry.
double	getDistance() The distance traveled from one waypoint to another.
double	getDuration() The estimated travel time from one waypoint to another.
java.util.List<LegStep>	getSteps() Gives a List including all the steps to get from one waypoint to another.
java.lang.String	getSummary() A short human-readable summary of major roads traversed.
void	setAnnotation(LegAnnotation annotation) Provide An LegAnnotation that contains additional details about each line segment along the route geometry.
void	setDistance(double distance) The distance traveled from one waypoint to another.
void	setDuration(double duration) The estimated travel time from one waypoint to another.
void	setSteps(java.util.List<LegStep> steps) Gives a List including all the steps to get from one waypoint to another.
void	setSummary(java.lang.String summary) A short human-readable summary of major roads traversed.

Methods inherited from class java.lang.Object

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

Constructor Detail

RouteLeg

public RouteLeg()

Empty constructor

Since:

2.0.0

Method Detail

getDistance

public double getDistance()

The distance traveled from one waypoint to another.

Returns:

a double number with unit meters.

Since:

1.0.0

setDistance

public void setDistance(double distance)

The distance traveled from one waypoint to another.

Parameters:

distance - a double number with unit meters.

Since:

2.1.0

getDuration

public double getDuration()

The estimated travel time from one waypoint to another.

Returns:

a double number with unit seconds.

Since:

1.0.0

setDuration

public void setDuration(double duration)

The estimated travel time from one waypoint to another.

Parameters:

duration - a double number with unit seconds.

Since:

2.1.0

getSummary

public java.lang.String getSummary()

A short human-readable summary of major roads traversed. Useful to distinguish alternatives.

Returns:

String with summary.

Since:

1.0.0

setSummary

public void setSummary(java.lang.String summary)

A short human-readable summary of major roads traversed. Useful to distinguish alternatives.

Parameters:

summary - a String with a human-readable summary.

Since:

2.1.0

getSteps

public java.util.List<LegStep> getSteps()

Gives a List including all the steps to get from one waypoint to another.

Returns:

List of LegStep.

Since:

1.0.0

setSteps

public void setSteps(java.util.List<LegStep> steps)

Gives a List including all the steps to get from one waypoint to another.

Parameters:

steps - a List of LegStep.

Since:

2.1.0

getAnnotation

public LegAnnotation getAnnotation()

An LegAnnotation that contains additional details about each line segment along the route geometry. If you'd like to receiving this, you must request it inside your Directions request before executing the call.

Returns:

a LegAnnotation object.

Since:

2.1.0

setAnnotation

public void setAnnotation(LegAnnotation annotation)

Provide An LegAnnotation that contains additional details about each line segment along the route geometry.

Parameters:

annotation - a LegAnnotation object.

Since:

2.1.0