Package org.opencabstandard.provider

Enum HOSContract.Clock.ValueType

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      COUNTDOWN
      Indicates that the value field will contain a date in RFC3339 format that will be shown as a clock counting down to zero.
      COUNTUP
      Indicates that the value field will contain a date in RFC3339 format that will be shown as a clock counting up from the provided date.
      DATE
      Indicates that the value field will contain a date in RFC3339 format.
      STRING
      The value field with contain a simple string.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString()  
      static HOSContract.Clock.ValueType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static HOSContract.Clock.ValueType[] 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, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • STRING

        public static final HOSContract.Clock.ValueType STRING
        The value field with contain a simple string. It can be informational information such as the driver username or something like "Adverse Weather Conditions".

      • DATE

        public static final HOSContract.Clock.ValueType DATE
        Indicates that the value field will contain a date in RFC3339 format. The date will appear formatted as "MM/dd/yyyy". An example for this type of clock could be the date of next required truck service.

      • COUNTUP

        public static final HOSContract.Clock.ValueType COUNTUP
        Indicates that the value field will contain a date in RFC3339 format that will be shown as a clock counting up from the provided date. An example for this type of clock could be the number of hours since last rest.

      • COUNTDOWN

        public static final HOSContract.Clock.ValueType COUNTDOWN
        Indicates that the value field will contain a date in RFC3339 format that will be shown as a clock counting down to zero. The counter will not go below zero. An example for this type of clock could be the remaining available drive time.

    • Method Detail

      • values

        public static HOSContract.Clock.ValueType[] 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 (HOSContract.Clock.ValueType c : HOSContract.Clock.ValueType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static HOSContract.Clock.ValueType 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