Package org.isda.cdm

Enum NotionalAdjustmentEnum

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

    public enum NotionalAdjustmentEnum
    extends java.lang.Enum<NotionalAdjustmentEnum>
    The enumerated values to specify the conditions that govern the adjustment to the number of units of the return swap.
    Version:
    2.5.4
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      EXECUTION
      The adjustments to the number of units are governed by an execution clause.
      PORTFOLIO_REBALANCING
      The adjustments to the number of units are governed by a portfolio rebalancing clause.
      STANDARD
      The adjustments to the number of units are not governed by any specific clause.
    • Method Summary

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

      • EXECUTION

        @RosettaSynonym(value="Execution",
                        source="FpML_5_10")
        public static final NotionalAdjustmentEnum EXECUTION
        The adjustments to the number of units are governed by an execution clause.
      • PORTFOLIO_REBALANCING

        @RosettaSynonym(value="PortfolioRebalancing",
                        source="FpML_5_10")
        public static final NotionalAdjustmentEnum PORTFOLIO_REBALANCING
        The adjustments to the number of units are governed by a portfolio rebalancing clause.
      • STANDARD

        @RosettaSynonym(value="Standard",
                        source="FpML_5_10")
        public static final NotionalAdjustmentEnum STANDARD
        The adjustments to the number of units are not governed by any specific clause.
    • Method Detail

      • values

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

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