Package es.situm.sdk.directions

Class DirectionsOptions

java.lang.Object

es.situm.sdk.directions.DirectionsOptions

public class DirectionsOptions
extends Object

Include additional parameters that determine how a route is computed, which links should be considered (either avoided or prioritized) when finding a route between two points.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DirectionsOptions.Builder	Helper class that creates well formed DirectionsOptions instances.

Method Summary

Modifier and Type	Method	Description
boolean	contains(DirectionsModifier.Actions modifierOption)	Checks if modifiers include a modifier for a specific action.
boolean	containsLegacyOptions()	Checks if modifiers contains any DirectionsModifier.LEGACY_OPTIONS option
List<DirectionsModifier>	getModifiers()	Returns the list of DirectionsModifier object included on the options

Methods inherited from class java.lang.Object

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

Method Details

getModifiers

public List<DirectionsModifier> getModifiers()

Returns the list of DirectionsModifier object included on the options

contains

public boolean contains(DirectionsModifier.Actions modifierOption)

Checks if modifiers include a modifier for a specific action.

Parameters:

modifierOption - DirectionsModifier.Actions option

Returns:

boolean value that determines if it is included (true) or not (false)

containsLegacyOptions

public boolean containsLegacyOptions()

Checks if modifiers contains any DirectionsModifier.LEGACY_OPTIONS option

Returns:

boolean value that indicates a DirectionsModifier.LEGACY_OPTIONS option is included (true) or not (false)