com.nbmap.api.directions.v5.models

Class Incident

java.lang.Object

com.nbmap.api.directions.v5.models.DirectionsJsonObject

com.nbmap.api.directions.v5.models.Incident

All Implemented Interfaces:

java.io.Serializable

public abstract class Incident
extends DirectionsJsonObject

Reproduces one of road incidents type (Incident.IncidentType) that might be on the way.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Incident.Builder This builder can be used to set the values describing the Incident.
static interface	Incident.ImpactType Impact type.
static interface	Incident.IncidentType Incident type.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IMPACT_CRITICAL Incident.ImpactType critical.
static java.lang.String	IMPACT_LOW Incident.ImpactType low.
static java.lang.String	IMPACT_MAJOR Incident.ImpactType major.
static java.lang.String	IMPACT_MINOR Incident.ImpactType minor.
static java.lang.String	IMPACT_UNKNOWN Incident.ImpactType unknown.
static java.lang.String	INCIDENT_ACCIDENT Incident.IncidentType accident.
static java.lang.String	INCIDENT_CONGESTION Incident.IncidentType congestion.
static java.lang.String	INCIDENT_CONSTRUCTION Incident.IncidentType construction.
static java.lang.String	INCIDENT_DISABLED_VEHICLE Incident.IncidentType disabled vehicle.
static java.lang.String	INCIDENT_LANE_RESTRICTION Incident.IncidentType lane restriction.
static java.lang.String	INCIDENT_MASS_TRANSIT Incident.IncidentType mass transit.
static java.lang.String	INCIDENT_MISCELLANEOUS Incident.IncidentType miscellaneous.
static java.lang.String	INCIDENT_OTHER_NEWS Incident.IncidentType other news.
static java.lang.String	INCIDENT_PLANNED_EVENT Incident.IncidentType planned event.
static java.lang.String	INCIDENT_ROAD_CLOSURE Incident.IncidentType road closure.
static java.lang.String	INCIDENT_ROAD_HAZARD Incident.IncidentType road hazard.
static java.lang.String	INCIDENT_WEATHER Incident.IncidentType weather.

Constructor Summary

Constructors

Constructor and Description
Incident()

Method Summary

Modifier and Type	Method and Description
abstract java.util.List<java.lang.Integer>	alertcCodes() AlertC codes.
static Incident.Builder	builder() Create a new instance of this class by using the Incident.Builder class.
abstract java.lang.Boolean	closed() True if road is closed and no possibility to pass through there.
abstract Congestion	congestion() Quantitative descriptor of congestion.
abstract java.lang.String	creationTime() Time the incident was created/updated in ISO8601 format.
abstract java.lang.String	description() Human-readable description of the incident suitable for displaying to the users.
abstract java.lang.String	endTime() End time of the incident in ISO8601 format.
static Incident	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract java.lang.Integer	geometryIndexEnd() Incident's geometry index end point.
abstract java.lang.Integer	geometryIndexStart() Incident's geometry index start point.
abstract java.lang.String	id() Unique identifier for incident.
abstract java.lang.String	impact() Severity level of incident.
abstract java.lang.String	longDescription() Human-readable long description of the incident suitable for displaying to the users.
abstract java.lang.String	startTime() Start time of the incident in ISO8601 format.
abstract java.lang.String	subType() Sub-type of the incident.
abstract java.lang.String	subTypeDescription() Sub-type-specific description.
abstract Incident.Builder	toBuilder() Convert the current Incident to its builder holding the currently assigned values.
abstract java.lang.String	type() One of incident types.
static com.google.gson.TypeAdapter<Incident>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.

Methods inherited from class com.nbmap.api.directions.v5.models.DirectionsJsonObject

toJson

Methods inherited from class java.lang.Object

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

Field Detail

INCIDENT_ACCIDENT

public static final java.lang.String INCIDENT_ACCIDENT

Incident.IncidentType accident.

See Also:

Constant Field Values

INCIDENT_CONGESTION

public static final java.lang.String INCIDENT_CONGESTION

Incident.IncidentType congestion.

See Also:

Constant Field Values

INCIDENT_CONSTRUCTION

public static final java.lang.String INCIDENT_CONSTRUCTION

Incident.IncidentType construction.

See Also:

Constant Field Values

INCIDENT_DISABLED_VEHICLE

public static final java.lang.String INCIDENT_DISABLED_VEHICLE

Incident.IncidentType disabled vehicle. ?

See Also:

Constant Field Values

INCIDENT_LANE_RESTRICTION

public static final java.lang.String INCIDENT_LANE_RESTRICTION

Incident.IncidentType lane restriction.

See Also:

Constant Field Values

INCIDENT_MASS_TRANSIT

public static final java.lang.String INCIDENT_MASS_TRANSIT

Incident.IncidentType mass transit.

See Also:

Constant Field Values

INCIDENT_MISCELLANEOUS

public static final java.lang.String INCIDENT_MISCELLANEOUS

Incident.IncidentType miscellaneous.

See Also:

Constant Field Values

INCIDENT_OTHER_NEWS

public static final java.lang.String INCIDENT_OTHER_NEWS

Incident.IncidentType other news.

See Also:

Constant Field Values

INCIDENT_PLANNED_EVENT

public static final java.lang.String INCIDENT_PLANNED_EVENT

Incident.IncidentType planned event.

See Also:

Constant Field Values

INCIDENT_ROAD_CLOSURE

public static final java.lang.String INCIDENT_ROAD_CLOSURE

Incident.IncidentType road closure.

See Also:

Constant Field Values

INCIDENT_ROAD_HAZARD

public static final java.lang.String INCIDENT_ROAD_HAZARD

Incident.IncidentType road hazard.

See Also:

Constant Field Values

INCIDENT_WEATHER

public static final java.lang.String INCIDENT_WEATHER

Incident.IncidentType weather.

See Also:

Constant Field Values

IMPACT_UNKNOWN

public static final java.lang.String IMPACT_UNKNOWN

Incident.ImpactType unknown.

See Also:

Constant Field Values

IMPACT_CRITICAL

public static final java.lang.String IMPACT_CRITICAL

Incident.ImpactType critical.

See Also:

Constant Field Values

IMPACT_MAJOR

public static final java.lang.String IMPACT_MAJOR

Incident.ImpactType major.

See Also:

Constant Field Values

IMPACT_MINOR

public static final java.lang.String IMPACT_MINOR

Incident.ImpactType minor.

See Also:

Constant Field Values

IMPACT_LOW

public static final java.lang.String IMPACT_LOW

Incident.ImpactType low.

See Also:

Constant Field Values

Constructor Detail

Incident

public Incident()

Method Detail

id

@NonNull
public abstract 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.

type

@Nullable
public abstract java.lang.String type()

One of incident types.

See Also:

Incident.IncidentType

closed

@Nullable
public abstract java.lang.Boolean closed()

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

congestion

@Nullable
public abstract Congestion congestion()

Quantitative descriptor of congestion.

description

@Nullable
public abstract java.lang.String description()

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

longDescription

@Nullable
 @SerializedName(value="long_description")
public abstract java.lang.String longDescription()

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

impact

@Nullable
public abstract java.lang.String impact()

Severity level of incident.

See Also:

Incident.ImpactType

subType

@Nullable
 @SerializedName(value="sub_type")
public abstract java.lang.String subType()

Sub-type of the incident.

subTypeDescription

@Nullable
 @SerializedName(value="sub_type_description")
public abstract java.lang.String subTypeDescription()

Sub-type-specific description.

alertcCodes

@Nullable
 @SerializedName(value="alertc_codes")
public abstract java.util.List<java.lang.Integer> alertcCodes()

AlertC codes.

See Also:

AlertC

geometryIndexStart

@Nullable
 @SerializedName(value="geometry_index_start")
public abstract java.lang.Integer geometryIndexStart()

Incident's geometry index start point.

geometryIndexEnd

@Nullable
 @SerializedName(value="geometry_index_end")
public abstract java.lang.Integer geometryIndexEnd()

Incident's geometry index end point.

creationTime

@Nullable
 @SerializedName(value="creation_time")
public abstract java.lang.String creationTime()

Time the incident was created/updated in ISO8601 format. Not the same startTime()/endTime(), incident can be created/updated before the incident.

startTime

@Nullable
 @SerializedName(value="start_time")
public abstract java.lang.String startTime()

Start time of the incident in ISO8601 format.

endTime

@Nullable
 @SerializedName(value="end_time")
public abstract java.lang.String endTime()

End time of the incident in ISO8601 format.

builder

public static Incident.Builder builder()

Create a new instance of this class by using the Incident.Builder class.

Returns:

this classes Incident.Builder for creating a new instance

toBuilder

public abstract Incident.Builder toBuilder()

Convert the current Incident to its builder holding the currently assigned values. This allows you to modify a single property and then rebuild the object resulting in an updated and modified Incident.

Returns:

a Incident.Builder with the same values set to match the ones defined in this Incident

typeAdapter

public static com.google.gson.TypeAdapter<Incident> typeAdapter(com.google.gson.Gson gson)

Gson type adapter for parsing Gson to this class.

Parameters:

gson - the built Gson object

Returns:

the type adapter for this class

fromJson

public static Incident fromJson(java.lang.String json)

Create a new instance of this class by passing in a formatted valid JSON String.

Parameters:

json - a formatted valid JSON string defining an Incident

Returns:

a new instance of this class defined by the values passed in the method