es.situm.sdk.navigation

Class NavigationRequest.Builder

java.lang.Object

es.situm.sdk.navigation.NavigationRequest.Builder

Enclosing class:

NavigationRequest

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

NavigationState builder static inner class.

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(NavigationRequest copy)

Method Summary

Modifier and Type	Method and Description
NavigationRequest	build() Returns a NavigationState with the previously set parameters.
NavigationRequest.Builder	distanceToGoalThreshold(double distanceToGoalThreshold) Sets the distance threshold from when the goal is considered reached.
NavigationRequest.Builder	distanceToIgnoreFirstIndication(double distanceToIgnoreFirstIndication) Sets the maximum distance to ignore the first indication when navigating a route.
NavigationRequest.Builder	outsideRouteThreshold(double outsideRouteThreshold) Sets the outsideRouteThreshold.
NavigationRequest.Builder	route(Route route) Sets the Route whose progress is going to be updated.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Builder

public Builder(NavigationRequest copy)

Method Detail

route

public NavigationRequest.Builder route(Route route)

Sets the Route whose progress is going to be updated.

Parameters:

route - the route to set, so that the methods can be chained together.

Returns:

a reference to this Builder

distanceToGoalThreshold

public NavigationRequest.Builder distanceToGoalThreshold(double distanceToGoalThreshold)

Sets the distance threshold from when the goal is considered reached. Default value is {NavigationRequest.DEFAULT_DISTANCE_THRESHOLD}.

Parameters:

distanceToGoalThreshold - the distanceToGoalThreshold to set, in meters.

Returns:

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

outsideRouteThreshold

public NavigationRequest.Builder outsideRouteThreshold(double outsideRouteThreshold)

Sets the outsideRouteThreshold. Default value is {NavigationRequest.DEFAULT_DISTANCE_THRESHOLD}.

Parameters:

outsideRouteThreshold - the outsideRouteThreshold to set

Returns:

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

distanceToIgnoreFirstIndication

public NavigationRequest.Builder distanceToIgnoreFirstIndication(double distanceToIgnoreFirstIndication)

Sets the maximum distance to ignore the first indication when navigating a route. This will allow to inform the user of the next turn some metres before reaching the intersection. Default value is {NavigationRequest.DEFAULT_DISTANCE_TO_IGNORE_FIRST_INDICATION}.

Parameters:

distanceToIgnoreFirstIndication - the distanceToIgnoreFirstIndication to set

Returns:

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

build

public NavigationRequest build()
                        throws java.lang.IllegalArgumentException

Returns a NavigationState with the previously set parameters.

Returns:

NavigationState

Throws:

java.lang.IllegalArgumentException