Package com.iizix

Enum TemperatureUnit

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

    public enum TemperatureUnit
    extends java.lang.Enum<TemperatureUnit>
    Enum for temperature types.
    • Enum Constant Summary

      Enum Constants 
      Enum ConstantDescription
      CELCIUS
      Celcius formatted as "°C".
      FAHRENHEIT
      Fahrenheit formatted as "°F".
      KELVIN
      Kelvin "°K".
      RANKINE
      Rankine "°R".
    • Field Summary

      Fields 
      Modifier and TypeFieldDescription
      java.lang.Stringsuffix
      Suffix for temperature value.
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethodDescription
      abstract doubletoCelcius​(double temperature)
      Converts the temperature of the current temperature unit to Celcius.
      abstract floattoCelcius​(float temperature)
      Converts the temperature of the current temperature unit to Celcius.
      abstract doubletoFahrenheit​(double temperature)
      Converts the temperature of the current temperature unit to Fahrenheit.
      abstract floattoFahrenheit​(float temperature)
      Converts the temperature of the current temperature unit to Fahrenheit.
      abstract doubletoKelvin​(double temperature)
      Converts the temperature of the current temperature unit to Kelvin.
      abstract floattoKelvin​(float temperature)
      Converts the temperature of the current temperature unit to Kelvin.
      abstract doubletoRankine​(double temperature)
      Converts the temperature of the current temperature unit to Rankine.
      abstract floattoRankine​(float temperature)
      Converts the temperature of the current temperature unit to Rankine.
      doubletoType​(double temperature, TemperatureUnit unit)
      Converts the temperature of the current temperature unit to the requested temperature unit type.
      floattoType​(float temperature, TemperatureUnit unit)
      Converts the temperature of the current temperature unit to the requested temperature unit type.
      static TemperatureUnitvalueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TemperatureUnit[]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

      • CELCIUS

        public static final TemperatureUnit CELCIUS
        Celcius formatted as "°C".
      • FAHRENHEIT

        public static final TemperatureUnit FAHRENHEIT
        Fahrenheit formatted as "°F".
    • Field Detail

      • suffix

        public final java.lang.String suffix
        Suffix for temperature value.
    • Method Detail

      • values

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

        public static TemperatureUnit 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
      • toCelcius

        public abstract double toCelcius​(double temperature)
        Converts the temperature of the current temperature unit to Celcius.
        Parameters:
        temperature - The temperature.
        Returns:
        The temperature in Celcius.
      • toCelcius

        public abstract float toCelcius​(float temperature)
        Converts the temperature of the current temperature unit to Celcius.
        Parameters:
        temperature - The temperature.
        Returns:
        The temperature in Celcius.
      • toFahrenheit

        public abstract double toFahrenheit​(double temperature)
        Converts the temperature of the current temperature unit to Fahrenheit.
        Parameters:
        temperature - The temperature.
        Returns:
        The temperature in Fahrenheit.
      • toFahrenheit

        public abstract float toFahrenheit​(float temperature)
        Converts the temperature of the current temperature unit to Fahrenheit.
        Parameters:
        temperature - The temperature.
        Returns:
        The temperature in Fahrenheit.
      • toKelvin

        public abstract double toKelvin​(double temperature)
        Converts the temperature of the current temperature unit to Kelvin.
        Parameters:
        temperature - The temperature.
        Returns:
        The temperature in Kelvin.
      • toKelvin

        public abstract float toKelvin​(float temperature)
        Converts the temperature of the current temperature unit to Kelvin.
        Parameters:
        temperature - The temperature.
        Returns:
        The temperature in Kelvin.
      • toRankine

        public abstract double toRankine​(double temperature)
        Converts the temperature of the current temperature unit to Rankine.
        Parameters:
        temperature - The temperature.
        Returns:
        The temperature in Rankine.
      • toRankine

        public abstract float toRankine​(float temperature)
        Converts the temperature of the current temperature unit to Rankine.
        Parameters:
        temperature - The temperature.
        Returns:
        The temperature in Rankine.
      • toType

        public double toType​(double temperature,
                             TemperatureUnit unit)
        Converts the temperature of the current temperature unit to the requested temperature unit type.
        Parameters:
        temperature - The temperature.
        unit - Requested conversion temperature unit type.
        Returns:
        The temperature in the requested unit type.
        Throws:
        java.lang.NullPointerException - If unit is null.
      • toType

        public float toType​(float temperature,
                            TemperatureUnit unit)
        Converts the temperature of the current temperature unit to the requested temperature unit type.
        Parameters:
        temperature - The temperature.
        unit - Requested conversion temperature unit type.
        Returns:
        The temperature in the requested unit type.
        Throws:
        java.lang.NullPointerException - If unit is null.