Enum TimeFormat

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TimeFormat>

    public enum TimeFormat
    extends java.lang.Enum<TimeFormat>
    Time formatting utility.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      HOURS
      Formats the given elapsed nanos as hours.
      MILLIS
      Formats the given elapsed nanos as milliseconds.
      MINUTES
      Formats the given elapsed nanos as minutes.
      MINUTES_AND_SECONDS
      Formats the given elapsed nanos as minutes and seconds.
      NANOS
      Formats the given elapsed nanos as nanoseconds.
      SECONDS
      Formats the given elapsed nanos as seconds.
      SECONDS_AND_MILLIS
      Formats the given elapsed nanos as seconds and milliseconds.
      UP_TO_HOURS
      Formats the given elapsed nanos as hours, minutes, seconds, milliseconds and nanoseconds.
      UP_TO_MILLIS
      Formats the given elapsed nanos as milliseconds and nanoseconds.
      UP_TO_MINUTES
      Formats the given elapsed nanos as minutes, seconds, milliseconds and nanoseconds.
      UP_TO_SECONDS
      Formats the given elapsed nanos as seconds, milliseconds and nanoseconds.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String format​(long nanos)
      Formats the given elapsed nanos into a string with time units.
      static TimeFormat valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TimeFormat[] 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

      • NANOS

        public static final TimeFormat NANOS
        Formats the given elapsed nanos as nanoseconds.
      • MILLIS

        public static final TimeFormat MILLIS
        Formats the given elapsed nanos as milliseconds.
      • SECONDS

        public static final TimeFormat SECONDS
        Formats the given elapsed nanos as seconds.
      • MINUTES

        public static final TimeFormat MINUTES
        Formats the given elapsed nanos as minutes.
      • HOURS

        public static final TimeFormat HOURS
        Formats the given elapsed nanos as hours.
      • SECONDS_AND_MILLIS

        public static final TimeFormat SECONDS_AND_MILLIS
        Formats the given elapsed nanos as seconds and milliseconds.
      • MINUTES_AND_SECONDS

        public static final TimeFormat MINUTES_AND_SECONDS
        Formats the given elapsed nanos as minutes and seconds.
      • UP_TO_MILLIS

        public static final TimeFormat UP_TO_MILLIS
        Formats the given elapsed nanos as milliseconds and nanoseconds.
      • UP_TO_SECONDS

        public static final TimeFormat UP_TO_SECONDS
        Formats the given elapsed nanos as seconds, milliseconds and nanoseconds.
      • UP_TO_MINUTES

        public static final TimeFormat UP_TO_MINUTES
        Formats the given elapsed nanos as minutes, seconds, milliseconds and nanoseconds.
      • UP_TO_HOURS

        public static final TimeFormat UP_TO_HOURS
        Formats the given elapsed nanos as hours, minutes, seconds, milliseconds and nanoseconds.
    • Method Detail

      • values

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

        public static TimeFormat 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
      • format

        public java.lang.String format​(long nanos)
        Formats the given elapsed nanos into a string with time units.
        Parameters:
        nanos - the elapsed time, in nanoseconds
        Returns:
        the formatted string