Package org.isda.cdm

Enum UnitEnum

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

    public enum UnitEnum
    extends java.lang.Enum<UnitEnum>
    The enumeration values to qualify the units of measure. FpML makes use of the priceQuoteUnitsScheme for specifying the units as part of its commodity implementation. Its scope is however deemed too broad for the CDM, as it includes values such as Amount and BasisPoints. As a result, it is deemed inappropriate as a reference scheme for that enumeration.
    Version:
    2.5.4
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BBL
      Barrel
      BSH
      Bushel
      GAL
      Gallon
      M_WH
      Megawatt-hour
      MMBTU
      Million British thermal units
    • Method Summary

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

      • M_WH

        @RosettaSynonym(value="MWh",
                        source="Rosetta_Workbench")
        public static final UnitEnum M_WH
        Megawatt-hour
      • MMBTU

        @RosettaSynonym(value="MMBTU",
                        source="Rosetta_Workbench")
        public static final UnitEnum MMBTU
        Million British thermal units
      • BBL

        @RosettaSynonym(value="BBL",
                        source="Rosetta_Workbench")
        public static final UnitEnum BBL
        Barrel
      • GAL

        @RosettaSynonym(value="GAL",
                        source="Rosetta_Workbench")
        public static final UnitEnum GAL
        Gallon
      • BSH

        @RosettaSynonym(value="BSH",
                        source="Rosetta_Workbench")
        public static final UnitEnum BSH
        Bushel
    • Method Detail

      • values

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

        public static UnitEnum 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
      • toString

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