Package org.refcodes.time

Enum TimeUnit


  • public enum TimeUnit
extends java.lang.Enum<TimeUnit>
    The Enum TimeUnit.
    Author:
    steiner

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      long getMilliseconds​()
      Returns the divisor for the time unit to be converted to seconds.
      static long toMilliseconds​(TimeUnit aTimeUnit, long aTime)
      Converts a given time from the provided TimeUnit to milliseconds.
      float toTime​(TimeUnit aFromTimeUnit, long aFromTime)
      Converts a given time from one TimeUnit to this instance's time unit.
      static float toTimeUnit​(TimeUnit aFromTimeUnit, long aTime, TimeUnit aToTimeUnit)
      Converts a given time from one TimeUnit to another TimeUnit.
      static TimeUnit valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TimeUnit[] 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

      • NANOSECOND

        public static final TimeUnit NANOSECOND

      • MILLISECOND

        public static final TimeUnit MILLISECOND

      • SECOND

        public static final TimeUnit SECOND

      • MINUTE

        public static final TimeUnit MINUTE

      • HOUR

        public static final TimeUnit HOUR

      • YEAR

        public static final TimeUnit YEAR

    • Method Detail

      • values

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

      • valueOf

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

      • getMilliseconds

        public long getMilliseconds​()
        Returns the divisor for the time unit to be converted to seconds.
        Returns:
        Divisor for the time unit to be converted to seconds.

      • toTime

        public float toTime​(TimeUnit aFromTimeUnit,
                    long aFromTime)
        Converts a given time from one TimeUnit to this instance's time unit.
        Parameters:
        aFromTimeUnit - The TimeUnit to convert from.
        aFromTime - The time to be converted.
        Returns:
        The converted time as of the current instance's time unit.

      • toTimeUnit

        public static float toTimeUnit​(TimeUnit aFromTimeUnit,
                               long aTime,
                               TimeUnit aToTimeUnit)
        Converts a given time from one TimeUnit to another TimeUnit.
        Parameters:
        aFromTimeUnit - The TimeUnit to convert from.
        aTime - The time to be converted.
        aToTimeUnit - The TimeUnit to convert to.
        Returns:
        The converted time.

      • toMilliseconds

        public static long toMilliseconds​(TimeUnit aTimeUnit,
                                  long aTime)
        Converts a given time from the provided TimeUnit to milliseconds.
        Parameters:
        aTimeUnit - The TimeUnit to convert from.
        aTime - The time to be converted to milliseconds.
        Returns:
        The converted time in milliseconds.