com.tomtom.online.sdk.map

Class RouteBuilder

java.lang.Object

com.tomtom.online.sdk.map.RouteBuilder

public class RouteBuilder
extends java.lang.Object

Builder class used to construct route object that can be added to the map.

Constructor Summary

Constructors

Constructor and Description
RouteBuilder(java.util.List<LatLng> coordinates) Default constructor to create route.

Method Summary

Modifier and Type	Method and Description
com.tomtom.online.sdk.map.RouteImpl	build() Used to construct route object.
RouteBuilder	endIcon(Icon endIcon) Icon added to the end point of the route.
RouteBuilder	isActive(boolean isActive) Flag indicating whether the route is active or not.
RouteBuilder	startIcon(Icon startIcon) Icon added to the start point of the route.
RouteBuilder	tag(java.io.Serializable tag) TAG is known android pattern to keep additional information.

Methods inherited from class java.lang.Object

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

Constructor Detail

RouteBuilder

public RouteBuilder(@NonNull
                    java.util.List<LatLng> coordinates)

Default constructor to create route. List of coordinates that represents route on the map is required to start.

Method Detail

endIcon

public RouteBuilder endIcon(Icon endIcon)

Icon added to the end point of the route. No icon will be shown when it is not provided.

startIcon

public RouteBuilder startIcon(Icon startIcon)

Icon added to the start point of the route. No icon will be shown when it is not provided.

isActive

public RouteBuilder isActive(boolean isActive)

Flag indicating whether the route is active or not. By default, a new route is inactive. Active route is drawn using blue color, gray is used otherwise.

tag

public RouteBuilder tag(java.io.Serializable tag)

TAG is known android pattern to keep additional information. If you want to keep some data associated with the route, this field can be used in such case.

build

public com.tomtom.online.sdk.map.RouteImpl build()

Used to construct route object.