com.tomtom.online.sdk.search.data.alongroute

Class AlongRouteSearchQueryBuilder

java.lang.Object

com.tomtom.online.sdk.search.data.alongroute.AlongRouteSearchQueryBuilder

All Implemented Interfaces:

IAlongRouteSearchQuery

public class AlongRouteSearchQueryBuilder
extends java.lang.Object
implements IAlongRouteSearchQuery

Builder class used to create AlongRouteSearchQuery.

Constructor Summary

Constructors

Constructor and Description
AlongRouteSearchQueryBuilder(java.lang.String term, java.util.List<LatLng> route, java.lang.Integer maxDetourTime)

Method Summary

Modifier and Type	Method and Description
AlongRouteSearchQuery	build() Creates new instance of AlongRouteSearchQuery
static AlongRouteSearchQueryBuilder	create(java.lang.String term, java.util.List<LatLng> route, java.lang.Integer maxDetourTime) Builder used to create an instance of AlongRouteSearchQuery, once constructed, the user cannot change the field values
AlongRouteSearchQueryBuilder	withBrandSet(java.lang.String brandSet) A comma-separated list of brand names which could be used to restrict the result to Points Of Interest of specific brands.
AlongRouteSearchQueryBuilder	withEVConnectorSetFilter(java.lang.String EVConnectorSetFilter) A comma-separated list of connector types which could be used to restrict the result to Points Of Interest of type Electric Vehicle Station, supporting specific connector types.
AlongRouteSearchQueryBuilder	withGeopoliticalView(java.lang.String geopoliticalView)
AlongRouteSearchQueryBuilder	withLimit(java.lang.Integer limit) The upper limit of the number of results.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlongRouteSearchQueryBuilder

public AlongRouteSearchQueryBuilder(java.lang.String term,
                                    java.util.List<LatLng> route,
                                    java.lang.Integer maxDetourTime)

Method Detail

withLimit

public AlongRouteSearchQueryBuilder withLimit(java.lang.Integer limit)

Description copied from interface: IAlongRouteSearchQuery

The upper limit of the number of results.

Specified by:

withLimit in interface IAlongRouteSearchQuery

Parameters:

limit - The upper limit of the number of results.

Returns:

The builder of the query with a new value for the limit set.

withGeopoliticalView

public AlongRouteSearchQueryBuilder withGeopoliticalView(java.lang.String geopoliticalView)

withEVConnectorSetFilter

public AlongRouteSearchQueryBuilder withEVConnectorSetFilter(java.lang.String EVConnectorSetFilter)

Description copied from interface: IAlongRouteSearchQuery

A comma-separated list of connector types which could be used to restrict the result to Points Of Interest of type Electric Vehicle Station, supporting specific connector types.

Specified by:

withEVConnectorSetFilter in interface IAlongRouteSearchQuery

Parameters:

EVConnectorSetFilter - A comma-separated list of connector types.

Returns:

The builder of the query with a new value for evConnectorSet.

withBrandSet

public AlongRouteSearchQueryBuilder withBrandSet(java.lang.String brandSet)

Description copied from interface: IAlongRouteSearchQuery

A comma-separated list of brand names which could be used to restrict the result to Points Of Interest of specific brands.

Specified by:

withBrandSet in interface IAlongRouteSearchQuery

Parameters:

brandSet - A comma-separated list of brand names.

Returns:

The builder of the query with a new value for brand set set.

create

public static AlongRouteSearchQueryBuilder create(java.lang.String term,
                                                  java.util.List<LatLng> route,
                                                  java.lang.Integer maxDetourTime)

Builder used to create an instance of AlongRouteSearchQuery, once constructed, the user cannot change the field values

Returns:

newly created builder object for AlongRouteSearchQuery to be used for further processing

build

public AlongRouteSearchQuery build()

Creates new instance of AlongRouteSearchQuery