Package com.navmii.sdk.routenavigation

Enum OnRouteState

java.lang.Object
java.lang.Enum<OnRouteState>
com.navmii.sdk.routenavigation.OnRouteState
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<OnRouteState>, java.lang.constant.Constable
public enum OnRouteState
extends java.lang.Enum<OnRouteState>
Represents on route state.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    OFF_ROUTE
    Indicates that current GPS coordinates are NOT considered to be on the current active route.
    ON_ROUTE
    Indicates that current GPS coordinates are considered to be on the current active route.
    UNDEFINED
    Indicates that relation between the current GPS coordinates and the current active route is undefined (i.e.

  • Method Summary

    Modifier and Type Method Description
    static OnRouteState valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static OnRouteState[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ON_ROUTE

      public static final OnRouteState ON_ROUTE
      Indicates that current GPS coordinates are considered to be on the current active route.

    • OFF_ROUTE

      public static final OnRouteState OFF_ROUTE
      Indicates that current GPS coordinates are NOT considered to be on the current active route.

    • UNDEFINED

      public static final OnRouteState UNDEFINED
      Indicates that relation between the current GPS coordinates and the current active route is undefined (i.e. no current GPS coordinates available, etc.).

  • Method Details

    • values

      public static OnRouteState[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static OnRouteState 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