com.mapbox.api.directions.v5.models

Class Incident.Builder

java.lang.Object

com.mapbox.api.directions.v5.models.Incident.Builder

Enclosing class:

Incident

public abstract static class Incident.Builder
extends java.lang.Object

This builder can be used to set the values describing the Incident.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract Incident.Builder	affectedRoadNames(java.util.List<java.lang.String> affectedRoadNames) Sets list of roads names affected by the incident.
abstract Incident.Builder	alertcCodes(java.util.List<java.lang.Integer> alertcCodes) AlertC codes.
abstract Incident	build() Build a new instance of Incident.
abstract Incident.Builder	closed(java.lang.Boolean closed) True if road is closed and no possibility to pass through there.
abstract Incident.Builder	congestion(Congestion congestion) Quantitative descriptor of congestion.
abstract Incident.Builder	countryCodeAlpha2(java.lang.String countryCodeAlpha2) Two letter country code where the incident is located.
abstract Incident.Builder	countryCodeAlpha3(java.lang.String countryCodeAlpha3) Three letter country code where the incident is located.
abstract Incident.Builder	creationTime(java.lang.String creationTime) Time the incident was created/updated in ISO8601 format.
abstract Incident.Builder	description(java.lang.String description) Human-readable description of the incident suitable for displaying to the users.
abstract Incident.Builder	endTime(java.lang.String endTime) End time in ISO8601 format.
abstract Incident.Builder	geometryIndexEnd(java.lang.Integer geometryIndexEnd) Incident's leg-wise geometry index end point.
abstract Incident.Builder	geometryIndexStart(java.lang.Integer geometryIndexStart) Incident's leg-wise geometry index start point.
abstract Incident.Builder	id(java.lang.String id) Unique identifier for incident.
abstract Incident.Builder	impact(java.lang.String impact) Severity level of incident.
abstract Incident.Builder	lanesBlocked(java.util.List<java.lang.String> lanesBlocked) A list of lanes that are blocked by the incident.
abstract Incident.Builder	longDescription(java.lang.String longDescription) Human-readable long description of the incident suitable for displaying to the users.
abstract Incident.Builder	numLanesBlocked(java.lang.Integer numLanesBlocked) The number of items in the Incident.lanesBlocked() list.
abstract Incident.Builder	startTime(java.lang.String startTime) Start time in ISO8601 format.
abstract Incident.Builder	subType(java.lang.String subType) Sub-type of the incident.
abstract Incident.Builder	subTypeDescription(java.lang.String subTypeDescription) Sub-type-specific description.
abstract Incident.Builder	trafficCodes(TrafficCodes trafficCodes) Traffic codes.
abstract Incident.Builder	type(java.lang.String type) One of incident types.
T	unrecognizedJsonProperties(java.util.Map<java.lang.String,com.google.gson.JsonElement> unrecognizedProperties) Use this method to add parameters which are not present in the model yet but are supported on the Directions API side in the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

id

@NonNull
public abstract Incident.Builder id(@NonNull
                                             java.lang.String id)

Unique identifier for incident. It might be the only one non-null filed which meant that incident started on previous leg and one has an incident with the same id.

Parameters:

id - String

type

@NonNull
public abstract Incident.Builder type(@Nullable
                                               java.lang.String type)

One of incident types.

Parameters:

type - incident type

See Also:

Incident.IncidentType

closed

@NonNull
public abstract Incident.Builder closed(@Nullable
                                                 java.lang.Boolean closed)

True if road is closed and no possibility to pass through there. False otherwise.

Parameters:

closed - is way closed

congestion

@NonNull
public abstract Incident.Builder congestion(@Nullable
                                                     Congestion congestion)

Quantitative descriptor of congestion.

Parameters:

congestion - congestion

description

@NonNull
public abstract Incident.Builder description(@Nullable
                                                      java.lang.String description)

Human-readable description of the incident suitable for displaying to the users.

Parameters:

description - incident description

longDescription

@NonNull
public abstract Incident.Builder longDescription(@Nullable
                                                          java.lang.String longDescription)

Human-readable long description of the incident suitable for displaying to the users.

Parameters:

longDescription - incident long description

impact

@NonNull
public abstract Incident.Builder impact(@Nullable
                                                 java.lang.String impact)

Severity level of incident.

Parameters:

impact - impact type

See Also:

Incident.ImpactType

subType

@NonNull
public abstract Incident.Builder subType(@Nullable
                                                  java.lang.String subType)

Sub-type of the incident.

Parameters:

subType - syp-type

subTypeDescription

@NonNull
public abstract Incident.Builder subTypeDescription(@Nullable
                                                             java.lang.String subTypeDescription)

Sub-type-specific description.

Parameters:

subTypeDescription - sub-type description

alertcCodes

@NonNull
public abstract Incident.Builder alertcCodes(@Nullable
                                                      java.util.List<java.lang.Integer> alertcCodes)

AlertC codes.

Parameters:

alertcCodes - list of alert codes

See Also:

AlertC

trafficCodes

@NonNull
public abstract Incident.Builder trafficCodes(@Nullable
                                                       TrafficCodes trafficCodes)

Traffic codes.

Parameters:

trafficCodes - traffic cods. See TrafficCodes.

geometryIndexStart

@NonNull
public abstract Incident.Builder geometryIndexStart(@Nullable
                                                             java.lang.Integer geometryIndexStart)

Incident's leg-wise geometry index start point.

Parameters:

geometryIndexStart - start index

geometryIndexEnd

@NonNull
public abstract Incident.Builder geometryIndexEnd(@Nullable
                                                           java.lang.Integer geometryIndexEnd)

Incident's leg-wise geometry index end point.

Parameters:

geometryIndexEnd - end index

creationTime

@NonNull
public abstract Incident.Builder creationTime(@Nullable
                                                       java.lang.String creationTime)

Time the incident was created/updated in ISO8601 format.

Parameters:

creationTime - ISO8601 format

startTime

@NonNull
public abstract Incident.Builder startTime(@Nullable
                                                    java.lang.String startTime)

Start time in ISO8601 format.

Parameters:

startTime - ISO8601 format

endTime

@NonNull
public abstract Incident.Builder endTime(@Nullable
                                                  java.lang.String endTime)

End time in ISO8601 format.

Parameters:

endTime - ISO8601 format

countryCodeAlpha2

@NonNull
public abstract Incident.Builder countryCodeAlpha2(@Nullable
                                                            java.lang.String countryCodeAlpha2)

Two letter country code where the incident is located.

Parameters:

countryCodeAlpha2 - 2 letter country code

See Also:

ISO Country code Wikipedia page

countryCodeAlpha3

@NonNull
public abstract Incident.Builder countryCodeAlpha3(@Nullable
                                                            java.lang.String countryCodeAlpha3)

Three letter country code where the incident is located.

Parameters:

countryCodeAlpha3 - 3 letter country code

See Also:

ISO Country code Wikipedia page

lanesBlocked

@NonNull
public abstract Incident.Builder lanesBlocked(@Nullable
                                                       java.util.List<java.lang.String> lanesBlocked)

A list of lanes that are blocked by the incident.

Parameters:

lanesBlocked - lanes blocked

numLanesBlocked

@NonNull
public abstract Incident.Builder numLanesBlocked(@Nullable
                                                          java.lang.Integer numLanesBlocked)

The number of items in the Incident.lanesBlocked() list.

Parameters:

numLanesBlocked - number lanes blocked

affectedRoadNames

@NonNull
public abstract Incident.Builder affectedRoadNames(@Nullable
                                                            java.util.List<java.lang.String> affectedRoadNames)

Sets list of roads names affected by the incident.

Parameters:

affectedRoadNames - list of roads names affected by the incident.

build

@NonNull
public abstract Incident build()

Build a new instance of Incident.

Returns:

a new instance of Incident.

unrecognizedJsonProperties

@NonNull
public T unrecognizedJsonProperties(@Nullable
                                             java.util.Map<java.lang.String,com.google.gson.JsonElement> unrecognizedProperties)

Use this method to add parameters which are not present in the model yet but are supported on the Directions API side in the response. Use it for experimental parameters.

Parameters:

unrecognizedProperties - parameters to add to request