com.tomtom.online.sdk.traffic.incidents.query

Class IncidentDetailsQueryBuilder

java.lang.Object

com.tomtom.online.sdk.traffic.incidents.query.IncidentDetailsQueryBuilder

All Implemented Interfaces:

IIncidentDetailsQuery

public class IncidentDetailsQueryBuilder
extends java.lang.Object
implements IIncidentDetailsQuery

The default builder for IncidentDetailsQuery objects.

Constructor Summary

Constructors

Constructor and Description
IncidentDetailsQueryBuilder(IncidentStyle style, com.tomtom.online.sdk.common.location.BoundingBox boundingBox, java.lang.Integer zoom, java.lang.String trafficModelId)

Method Summary

Modifier and Type	Method and Description
IncidentDetailsQuery	build() Creates new instance of IncidentDetailsQuery
static IncidentDetailsQueryBuilder	create(IncidentStyle style, com.tomtom.online.sdk.common.location.BoundingBox boundingBox, java.lang.Integer zoom, java.lang.String trafficModelId) Builder used to create an instance of IncidentDetailsQuery, once constructed, the user cannot change the field values
IncidentDetailsQueryBuilder	withExpandCluster(java.lang.Boolean expandCluster) Sets whether a list of separate incidents should be added to clusters.
IncidentDetailsQueryBuilder	withGeometryType(IncidentGeometryType geometryType) Sets the type of vector geometry added to incidents
IncidentDetailsQueryBuilder	withIncludeOriginalPosition(java.lang.Boolean includeOriginalPosition) Sets whether the original position of the incident should be returned along with the one shifter to the beginning of the traffic tube.
IncidentDetailsQueryBuilder	withIsoLanguage(java.lang.String isoLanguage) ISO 639-1 code for the output language.
IncidentDetailsQueryBuilder	withLanguage(IncidentResponseLanguage language) Sets the language to use in the response to created query.

Methods inherited from class java.lang.Object

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

Constructor Detail

IncidentDetailsQueryBuilder

public IncidentDetailsQueryBuilder(IncidentStyle style,
                                   com.tomtom.online.sdk.common.location.BoundingBox boundingBox,
                                   java.lang.Integer zoom,
                                   java.lang.String trafficModelId)

Method Detail

withLanguage

public IncidentDetailsQueryBuilder withLanguage(IncidentResponseLanguage language)

Description copied from interface: IIncidentDetailsQuery

Sets the language to use in the response to created query.

Specified by:

withLanguage in interface IIncidentDetailsQuery

Parameters:

language - the language to use in the response to created query

Returns:

a reference to this object

withGeometryType

public IncidentDetailsQueryBuilder withGeometryType(IncidentGeometryType geometryType)

Description copied from interface: IIncidentDetailsQuery

Sets the type of vector geometry added to incidents

Specified by:

withGeometryType in interface IIncidentDetailsQuery

Parameters:

geometryType - the type of vector geometry added to incidents

Returns:

a reference to this object

withExpandCluster

public IncidentDetailsQueryBuilder withExpandCluster(java.lang.Boolean expandCluster)

Description copied from interface: IIncidentDetailsQuery

Sets whether a list of separate incidents should be added to clusters.

Specified by:

withExpandCluster in interface IIncidentDetailsQuery

Parameters:

expandCluster - if true, clusters will contain a list of incidents in addition to cluster data

Returns:

a reference to this object

withIncludeOriginalPosition

public IncidentDetailsQueryBuilder withIncludeOriginalPosition(java.lang.Boolean includeOriginalPosition)

Description copied from interface: IIncidentDetailsQuery

Sets whether the original position of the incident should be returned along with the one shifter to the beginning of the traffic tube.

Specified by:

withIncludeOriginalPosition in interface IIncidentDetailsQuery

Parameters:

includeOriginalPosition - if true, the original position of the incident is included in the response

Returns:

a reference to this object

withIsoLanguage

public IncidentDetailsQueryBuilder withIsoLanguage(java.lang.String isoLanguage)

Description copied from interface: IIncidentDetailsQuery

ISO 639-1 code for the output language. See https://developer.tomtom.com/online-traffic/online-traffic-documentation-online-traffic-incidents/traffic-incident-details for a list of supported languages and their ISO codes.

Specified by:

withIsoLanguage in interface IIncidentDetailsQuery

Parameters:

isoLanguage - the language to use in the response to created query

Returns:

a reference to this object

create

public static IncidentDetailsQueryBuilder create(IncidentStyle style,
                                                 com.tomtom.online.sdk.common.location.BoundingBox boundingBox,
                                                 java.lang.Integer zoom,
                                                 java.lang.String trafficModelId)

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

Returns:

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

build

public IncidentDetailsQuery build()

Creates new instance of IncidentDetailsQuery