com.tomtom.online.sdk.traffic.flow.response

Enum FunctionalRoadClass

java.lang.Object

java.lang.Enum<FunctionalRoadClass>

com.tomtom.online.sdk.traffic.flow.response.FunctionalRoadClass

All Implemented Interfaces:

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

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

Represents the road type of the traffic flow segment.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INVALID Represents that the road type is invalid.
LOCAL_CONNECTING_ROAD Represents a local connecting road.
LOCAL_ROAD Represents a local road.
LOCAL_ROAD_OF_HIGH_IMPORTANCE Represents a local road of high importance.
MAJOR_ROAD Represents a major road that is less important than a motorway.
MOTORWAY Represents a motorway, freeway, or other major road.
OTHER_MAJOR_ROAD Represent another major road.
SECONDARY_ROAD Represents a secondary road.

Method Summary

Modifier and Type	Method and Description
static FunctionalRoadClass	fromInt(int value) Static method used for searching through enum to check if passed value is valid.
int	getValue() Getter for the value of the current type of road.
static FunctionalRoadClass	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FunctionalRoadClass[]	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

INVALID

public static final FunctionalRoadClass INVALID

Represents that the road type is invalid.

MOTORWAY

public static final FunctionalRoadClass MOTORWAY

Represents a motorway, freeway, or other major road.

MAJOR_ROAD

public static final FunctionalRoadClass MAJOR_ROAD

Represents a major road that is less important than a motorway.

OTHER_MAJOR_ROAD

public static final FunctionalRoadClass OTHER_MAJOR_ROAD

Represent another major road.

SECONDARY_ROAD

public static final FunctionalRoadClass SECONDARY_ROAD

Represents a secondary road.

LOCAL_CONNECTING_ROAD

public static final FunctionalRoadClass LOCAL_CONNECTING_ROAD

Represents a local connecting road.

LOCAL_ROAD_OF_HIGH_IMPORTANCE

public static final FunctionalRoadClass LOCAL_ROAD_OF_HIGH_IMPORTANCE

Represents a local road of high importance.

LOCAL_ROAD

public static final FunctionalRoadClass LOCAL_ROAD

Represents a local road.

Method Detail

values

public static FunctionalRoadClass[] 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 (FunctionalRoadClass c : FunctionalRoadClass.values())
    System.out.println(c);

Returns:

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

valueOf

public static FunctionalRoadClass 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 for the value of the current type of road. Also used for searching purposes in fromInt(int).

fromInt

@NonNull
public static FunctionalRoadClass fromInt(int value)

Static method used for searching through enum to check if passed value is valid. If no proper value is found method returns INVALID.

Parameters:

value - integer that should return a proper functional road class.