com.tomtom.online.sdk.traffic.incidents.response

Enum IncidentMagnitude

java.lang.Object

java.lang.Enum<IncidentMagnitude>

com.tomtom.online.sdk.traffic.incidents.response.IncidentMagnitude

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IncidentMagnitude>

public enum IncidentMagnitude
extends java.lang.Enum<IncidentMagnitude>

The magnitude of the delay associated with an incident. These values correspond to incident colors in traffic tiles.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAJOR Delay from the incident is major.
MINOR Delay from the incident is minor.
MODERATE Delay from the incident is moderate.
UNDEFINED Delay from the incident is undefined.
UNKNOWN There is an unknown type of delay.

Method Summary

Modifier and Type	Method and Description
static IncidentMagnitude	fromInt(int value) Static method used to search trough enum and retrieve incident magnitude based on passed value.
int	getValue() Getter of the current incident magnitude used in fromInt(int) for searching purposes.
static IncidentMagnitude	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IncidentMagnitude[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final IncidentMagnitude UNKNOWN

There is an unknown type of delay. Color will be grey.

MINOR

public static final IncidentMagnitude MINOR

Delay from the incident is minor. Color will be orange.

MODERATE

public static final IncidentMagnitude MODERATE

Delay from the incident is moderate. Color will be a mix between an orange and red color.

MAJOR

public static final IncidentMagnitude MAJOR

Delay from the incident is major. Color will be red.

UNDEFINED

public static final IncidentMagnitude UNDEFINED

Delay from the incident is undefined. Color will be grey.

Method Detail

values

public static IncidentMagnitude[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IncidentMagnitude c : IncidentMagnitude.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IncidentMagnitude valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValue

public int getValue()

Getter of the current incident magnitude used in fromInt(int) for searching purposes.

fromInt

@NonNull
public static IncidentMagnitude fromInt(int value)

Static method used to search trough enum and retrieve incident magnitude based on passed value. If the value is valid then proper IncidentMagnitude is returned, otherwise IllegalArgumentException is thrown.

Parameters:

Value - passed that is going to be searched in enum.