public class Route
extends java.lang.Object
Instances are immutable.
Modifier and Type | Field and Description |
---|---|
static <any> |
CREATOR |
Constructor and Description |
---|
Route(DirectionsRequest request,
java.util.List<RouteStep> steps,
java.util.List<Indication> indications,
Building building,
java.util.Collection<Floor> buildingFloors)
Just for internal SDK use
|
Modifier and Type | Method and Description |
---|---|
int |
describeContents() |
boolean |
equals(java.lang.Object o) |
DirectionsRequest.AccessibilityMode |
getAccessibilityMode()
Returns the current route accessibility mode.
|
double |
getDistance()
Returns the route distance (in meters)
|
java.util.Collection<RouteStep> |
getEdges()
Equal to
getSteps() . |
RouteStep |
getFirstStep()
Returns first step
|
Point |
getFrom()
Point where the route starts.
|
java.util.List<Indication> |
getIndications()
Return ordered list of instructions to go to the destination
|
RouteStep |
getLastStep()
Returns last step
|
java.util.Collection<Point> |
getNodes()
Returns a collection of points of the route (not ordered)
|
java.util.List<Point> |
getPoints()
Returns list of ordered points of the route
|
DirectionsRequest |
getRequest()
Returns the search criteria, provided to
DirectionsManager , whose result is the current Route . |
InternalRouteInfo |
getRouteInfo()
Just for internal SDK use.
|
RouteStep |
getStep(int stepId)
Returns a route step by its
RouteStep.getId() |
java.util.List<RouteStep> |
getSteps()
Returns ordered list of steps to go to the goal point
|
Point |
getTo()
Last point and goal of the route.
|
int |
hashCode() |
Indication |
indicationForNextStep(int routeStepIndex)
Returns the next indication to a given step.
|
boolean |
isAccessible()
Deprecated.
|
java.lang.String |
toString() |
void |
writeToParcel(Parcel dest,
int flags) |
public Route(DirectionsRequest request, java.util.List<RouteStep> steps, java.util.List<Indication> indications, Building building, java.util.Collection<Floor> buildingFloors)
java.lang.IllegalArgumentException
- if null value is provided to NonNull parameter,
or empty list is provided to size(min = 1) parameterpublic java.util.Collection<RouteStep> getEdges()
getSteps()
. Allows handling Route as a Graph
.public java.util.Collection<Point> getNodes()
public java.util.List<Point> getPoints()
public java.util.List<RouteStep> getSteps()
RouteStep
public RouteStep getFirstStep()
RouteStep.getFrom()
is the request parameter DirectionsRequest.getFrom()
public RouteStep getLastStep()
RouteStep.getTo()
is the request parameter DirectionsRequest.getTo()
public RouteStep getStep(int stepId)
RouteStep.getId()
stepId
- id of step (RouteStep.getId()
)public InternalRouteInfo getRouteInfo()
public java.util.List<Indication> getIndications()
public DirectionsRequest getRequest()
DirectionsManager
, whose result is the current Route
.DirectionsRequest
@Deprecated public boolean isAccessible()
DirectionsRequest.isAccessible()
from getRequest()
.public DirectionsRequest.AccessibilityMode getAccessibilityMode()
DirectionsRequest.getAccessibilityMode()
()} from getRequest()
.DirectionsRequest.AccessibilityMode
public Point getFrom()
DirectionsRequest.getFrom()
from getRequest()
.Point
public Point getTo()
DirectionsRequest.getTo()
from getTo()
.Point
public Indication indicationForNextStep(int routeStepIndex)
routeStepIndex
- the index of a route step inside a routeIndication
object or empty if the routeStepIndex is not validpublic double getDistance()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public int describeContents()
public void writeToParcel(Parcel dest, int flags)