Package org.pkl.core

Enum DurationUnit

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DurationUnit>
    public enum DurationUnit
extends java.lang.Enum<DurationUnit>
    The unit of a Duration. In Pkl, duration units are represented as String symbols.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      long getNanos()
      Returns the conversion factor from this unit to nanoseconds.
      java.lang.String getSymbol()
      Returns the string symbol of this unit.
      static @Nullable DurationUnit parse​(java.lang.String symbol)
      Returns the unit with the given symbol, or null if no unit with the given symbol exists.
      java.time.temporal.ChronoUnit toChronoUnit()
      Converts this unit to a ChronoUnit.
      java.lang.String toString()  
      java.util.concurrent.TimeUnit toTimeUnit()
      Converts this unit to a TimeUnit.
      static DurationUnit valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DurationUnit[] 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

    • Method Detail

      • values

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

      • valueOf

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

      • parse

        public static @Nullable DurationUnit parse​(java.lang.String symbol)
        Returns the unit with the given symbol, or null if no unit with the given symbol exists.

      • getSymbol

        public java.lang.String getSymbol()
        Returns the string symbol of this unit.

      • getNanos

        public long getNanos()
        Returns the conversion factor from this unit to nanoseconds.

      • toChronoUnit

        public java.time.temporal.ChronoUnit toChronoUnit()
        Converts this unit to a ChronoUnit.

      • toTimeUnit

        public java.util.concurrent.TimeUnit toTimeUnit()
        Converts this unit to a TimeUnit.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<DurationUnit>