com.mapbox.services.android.navigation.v5.osrm

Class TextInstructions

java.lang.Object

com.mapbox.services.android.navigation.v5.osrm.TextInstructions

public class TextInstructions
extends java.lang.Object

Text instructions from OSRM route responses

This is an experimental API. Experimental APIs are quickly evolving and might change or be removed in minor versions.

Since:

0.1.0

Constructor Summary

Constructors

Constructor and Description
TextInstructions(java.lang.String language, java.lang.String version)

Method Summary

Modifier and Type	Method and Description
static java.lang.String	capitalizeFirstLetter(java.lang.String text)
java.lang.String	compile(com.mapbox.services.api.directions.v5.models.LegStep step)
java.lang.String	directionFromDegree(java.lang.Double degree) Transform degrees to their translated compass direction
com.google.gson.JsonObject	getRootObject()
TokenizedInstructionHook	getTokenizedInstructionHook()
com.google.gson.JsonObject	getVersionObject()
java.lang.String	laneConfig(com.mapbox.services.api.directions.v5.models.LegStep step) Reduce any lane combination down to a contracted lane diagram
java.lang.String	ordinalize(java.lang.Integer number) Transform numbers to their translated ordinalized value
void	setTokenizedInstructionHook(TokenizedInstructionHook tokenizedInstructionHook)

Methods inherited from class java.lang.Object

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

Constructor Detail

TextInstructions

public TextInstructions(java.lang.String language,
                        java.lang.String version)

Method Detail

getTokenizedInstructionHook

public TokenizedInstructionHook getTokenizedInstructionHook()

setTokenizedInstructionHook

public void setTokenizedInstructionHook(TokenizedInstructionHook tokenizedInstructionHook)

getRootObject

public com.google.gson.JsonObject getRootObject()

getVersionObject

public com.google.gson.JsonObject getVersionObject()

capitalizeFirstLetter

public static java.lang.String capitalizeFirstLetter(java.lang.String text)

ordinalize

public java.lang.String ordinalize(java.lang.Integer number)

Transform numbers to their translated ordinalized value

Parameters:

number - value

Returns:

translated ordinalized value

directionFromDegree

public java.lang.String directionFromDegree(java.lang.Double degree)

Transform degrees to their translated compass direction

Parameters:

degree - value

Returns:

translated compass direction

laneConfig

public java.lang.String laneConfig(com.mapbox.services.api.directions.v5.models.LegStep step)

Reduce any lane combination down to a contracted lane diagram

Parameters:

step - a route step

compile

public java.lang.String compile(com.mapbox.services.api.directions.v5.models.LegStep step)