Package org.isda.cdm

Enum RoundingDirectionEnum

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

    public enum RoundingDirectionEnum
    extends java.lang.Enum<RoundingDirectionEnum>
    The enumerated values to specify the rounding direction and precision to be used in the rounding of a rate.
    Version:
    2.5.4
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DOWN
      A fractional number will be rounded down to the specified number of decimal places (the precision).
      NEAREST
      A fractional number will be rounded either up or down to the specified number of decimal places (the precision) depending on its value.
      UP
      A fractional number will be rounded up to the specified number of decimal places (the precision).
    • Method Summary

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

      • UP

        @RosettaSynonym(value="Up",source="FpML_5_10") @RosettaSynonym(value="Up",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="Up",source="DTCC_11_0") @RosettaSynonym(value="Up",source="DTCC_9_0") @RosettaSynonym(value="Up",source="CME_ClearedConfirm_1_17")
        public static final RoundingDirectionEnum UP
        A fractional number will be rounded up to the specified number of decimal places (the precision). For example, 5.21 and 5.25 rounded up to 1 decimal place are 5.3 and 5.3 respectively.
      • DOWN

        @RosettaSynonym(value="Down",source="FpML_5_10") @RosettaSynonym(value="Down",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="Down",source="DTCC_11_0") @RosettaSynonym(value="Down",source="DTCC_9_0") @RosettaSynonym(value="Down",source="CME_ClearedConfirm_1_17")
        public static final RoundingDirectionEnum DOWN
        A fractional number will be rounded down to the specified number of decimal places (the precision). For example, 5.29 and 5.25 rounded down to 1 decimal place are 5.2 and 5.2 respectively.
      • NEAREST

        @RosettaSynonym(value="Nearest",source="FpML_5_10") @RosettaSynonym(value="Nearest",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="Nearest",source="DTCC_11_0") @RosettaSynonym(value="Nearest",source="DTCC_9_0") @RosettaSynonym(value="Nearest",source="CME_ClearedConfirm_1_17")
        public static final RoundingDirectionEnum NEAREST
        A fractional number will be rounded either up or down to the specified number of decimal places (the precision) depending on its value. For example, 5.24 would be rounded down to 5.2 and 5.25 would be rounded up to 5.3 if a precision of 1 decimal place were specified.
    • Method Detail

      • values

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

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