com.tomtom.online.sdk.traffic.flow.query

Enum FlowSegmentSpeedUnit

java.lang.Object

java.lang.Enum<FlowSegmentSpeedUnit>

com.tomtom.online.sdk.traffic.flow.query.FlowSegmentSpeedUnit

All Implemented Interfaces:

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

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

Represents the speed unit.

Enum Constant Summary

Enum Constants

Enum Constant and Description
KMPH Defines the speed unit as kilometers per hour.
MPH Defines the speed unit as miles per hour.

Method Summary

Modifier and Type	Method and Description
static FlowSegmentSpeedUnit	fromInt(int value) Static method used to search if the passed value is a valid speed unit type and returns FlowSegmentSpeedUnit.
int	getValue() Getter used to retrieve the current type of speed unit.
static FlowSegmentSpeedUnit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FlowSegmentSpeedUnit[]	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

KMPH

public static final FlowSegmentSpeedUnit KMPH

Defines the speed unit as kilometers per hour.

MPH

public static final FlowSegmentSpeedUnit MPH

Defines the speed unit as miles per hour.

Method Detail

values

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

Returns:

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

valueOf

public static FlowSegmentSpeedUnit 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 used to retrieve the current type of speed unit. Also used in fromInt(int).

fromInt

@NonNull
public static FlowSegmentSpeedUnit fromInt(int value)

Static method used to search if the passed value is a valid speed unit type and returns FlowSegmentSpeedUnit. If the value passed is invalid, then IllegalArgumentException is thrown.

Parameters:

value - An integer to be searched.