com.mapbox.api.directions.v5.models

Class Notification

java.lang.Object

com.mapbox.api.directions.v5.models.DirectionsJsonObject

com.mapbox.api.directions.v5.models.Notification

All Implemented Interfaces:

java.io.Serializable

public abstract class Notification
extends DirectionsJsonObject

Class containing information about route notification. See RouteLeg.notifications().

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Notification.Builder This builder can be used to set the values describing the Notification.

Constructor Summary

Constructors

Constructor and Description
Notification()

Method Summary

Modifier and Type	Method and Description
static Notification.Builder	builder() Create a new instance of this class by using the Notification.Builder class.
abstract java.lang.String	chargingStationId() Notification charging station id.
abstract NotificationDetails	details() Notification details specific to type() and subtype().
static Notification	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
abstract java.lang.Integer	geometryIndex() Leg-wise position in the coordinate list where the notification occurred, relative to the start of the leg it's on.
abstract java.lang.Integer	geometryIndexEnd() Leg-wise end index of the area that violates the request parameter.
abstract java.lang.Integer	geometryIndexStart() Leg-wise start index of the area that violates the request parameter.
abstract java.lang.String	reason() Notification reason.
abstract java.lang.String	refreshType() Notification refresh type.
abstract java.lang.String	subtype() Notification subtype.
abstract Notification.Builder	toBuilder() Convert the current Notification to its builder holding the currently assigned values.
abstract java.lang.String	type() Notification type.
static com.google.gson.TypeAdapter<Notification>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.

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

getUnrecognizedJsonProperties, getUnrecognizedPropertiesNames, getUnrecognizedProperty, toJson

Methods inherited from class java.lang.Object

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

Constructor Detail

Notification

public Notification()

Method Detail

builder

public static Notification.Builder builder()

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

Returns:

this classes Notification.Builder for creating a new instance

type

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

Notification type. Can be one of DirectionsCriteria.NotificationsTypeCriteria.

Returns:

notification type

refreshType

@SerializedName(value="refresh_type")
 @NonNull
public abstract java.lang.String refreshType()

Notification refresh type. Can be one of DirectionsCriteria.NotificationsRefreshTypeCriteria.

Returns:

notification refresh type

subtype

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

Notification subtype. Can be one of DirectionsCriteria.NotificationsSubtypeCriteria, depending on type().

Returns:

notification subtype

geometryIndexStart

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

Leg-wise start index of the area that violates the request parameter. This value is present only for DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_HEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WIDTH, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_UNPAVED, DirectionsCriteria.NOTIFICATION_SUBTYPE_POINT_EXCLUSION, DirectionsCriteria.NOTIFICATION_SUBTYPE_COUNTRY_BORDER_CROSSING, DirectionsCriteria.NOTIFICATION_SUBTYPE_STATE_BORDER_CROSSING otherwise it is null

Returns:

start index

geometryIndex

@SerializedName(value="geometry_index")
 @Nullable
public abstract java.lang.Integer geometryIndex()

Leg-wise position in the coordinate list where the notification occurred, relative to the start of the leg it's on. This value is present only for DirectionsCriteria.NOTIFICATION_SUBTYPE_EV_INSUFFICIENT_CHARGE otherwise it is null.

Returns:

index position in the coordinate list

geometryIndexEnd

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

Leg-wise end index of the area that violates the request parameter. This value is present only for DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_HEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WIDTH, DirectionsCriteria.NOTIFICATION_SUBTYPE_MAX_WEIGHT, DirectionsCriteria.NOTIFICATION_SUBTYPE_UNPAVED, DirectionsCriteria.NOTIFICATION_SUBTYPE_POINT_EXCLUSION, DirectionsCriteria.NOTIFICATION_SUBTYPE_COUNTRY_BORDER_CROSSING, DirectionsCriteria.NOTIFICATION_SUBTYPE_STATE_BORDER_CROSSING otherwise it is null

Returns:

end index

details

@Nullable
public abstract NotificationDetails details()

Notification details specific to type() and subtype().

Returns:

notification details

reason

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

Notification reason. It is valid only if type() is DirectionsCriteria.NOTIFICATION_TYPE_ALERT and subtype() is DirectionsCriteria.NOTIFICATION_SUBTYPE_EV_STATION_UNAVAILABLE.

Returns:

reason for the unavailability of the charging station for the electric vehicle

chargingStationId

@Nullable
 @SerializedName(value="station_id")
public abstract java.lang.String chargingStationId()

Notification charging station id. It is valid only if type() is DirectionsCriteria.NOTIFICATION_TYPE_ALERT and subtype() is DirectionsCriteria.NOTIFICATION_SUBTYPE_EV_STATION_UNAVAILABLE.

Returns:

charging station id of the unavailable charging station for the electric vehicle

toBuilder

public abstract Notification.Builder toBuilder()

Convert the current Notification 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 Notification.

Returns:

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

typeAdapter

public static com.google.gson.TypeAdapter<Notification> 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 Notification 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 a Notification

Returns:

a new instance of this class defined by the values passed inside this static factory method