es.situm.sdk.directions

Class DirectionsRequest.Builder

java.lang.Object

es.situm.sdk.directions.DirectionsRequest.Builder

Enclosing class:

DirectionsRequest

public static final class DirectionsRequest.Builder
extends java.lang.Object

DirectionsRequest builder static inner class.

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(DirectionsRequest copy)

Method Summary

Modifier and Type	Method and Description
DirectionsRequest	build() Returns a DirectionsRequest built from the parameters previously set.
DirectionsRequest.Builder	from(Location currentLocation) Sets the current user's position as the starting point of the route.
DirectionsRequest.Builder	from(Point from, Angle bearingFrom) Sets the starting point of the route, and the bearing of the user to generate the appropriate instructions.
DirectionsRequest.Builder	isAccessible(boolean isAccessible) Sets if the route has to be suitable for wheel chairs (true) or not (false)
DirectionsRequest.Builder	to(Point to) Sets the point to, where the route should end.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Builder

public Builder(DirectionsRequest copy)

Method Detail

from

public DirectionsRequest.Builder from(Point from,
                                      Angle bearingFrom)

Sets the starting point of the route, and the bearing of the user to generate the appropriate instructions.

Parameters:

from - Point point inside a building (Point.isIndoor() == true)

bearingFrom - Angle user's bearing

Returns:

a reference to this Builder, so that the methods can be chained together.

from

public DirectionsRequest.Builder from(Location currentLocation)

Sets the current user's position as the starting point of the route.

Parameters:

currentLocation - current user's Location, obtained with LocationManager

Returns:

a reference to this Builder, so that the methods can be chained together.

to

public DirectionsRequest.Builder to(Point to)

Sets the point to, where the route should end.

Parameters:

to - Point point inside a building (Point.isIndoor() == true)

Returns:

a reference to this Builder, so that the methods can be chained together.

isAccessible

public DirectionsRequest.Builder isAccessible(boolean isAccessible)

Sets if the route has to be suitable for wheel chairs (true) or not (false)

Parameters:

isAccessible - boolean

Returns:

a reference to this Builder, so that the methods can be chained together.

build

public DirectionsRequest build()

Returns a DirectionsRequest built from the parameters previously set.

Returns:

a DirectionsRequest built with parameters of this DirectionsRequest.Builder