Package org.isda.cdm

Enum DividendAmountTypeEnum

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

    public enum DividendAmountTypeEnum
    extends java.lang.Enum<DividendAmountTypeEnum>
    The enumerated values to specify whether the dividend is paid with respect to the Dividend Period.
    Version:
    2.5.4
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AS_SPECIFIED_IN_MASTER_CONFIRMATION
      The Amount is determined as provided in the relevant Master Confirmation.
      EX_AMOUNT
      The ex-date for a dividend occurs during a dividend period.
      PAID_AMOUNT
      The payment date for a dividend occurs during a dividend period.
      RECORD_AMOUNT
      The record date for a dividend occurs during a dividend period.
    • Method Summary

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

      • RECORD_AMOUNT

        @RosettaSynonym(value="RecordAmount",
                        source="FpML_5_10")
        public static final DividendAmountTypeEnum RECORD_AMOUNT
        The record date for a dividend occurs during a dividend period.
      • EX_AMOUNT

        @RosettaSynonym(value="ExAmount",
                        source="FpML_5_10")
        public static final DividendAmountTypeEnum EX_AMOUNT
        The ex-date for a dividend occurs during a dividend period.
      • PAID_AMOUNT

        @RosettaSynonym(value="PaidAmount",
                        source="FpML_5_10")
        public static final DividendAmountTypeEnum PAID_AMOUNT
        The payment date for a dividend occurs during a dividend period.
      • AS_SPECIFIED_IN_MASTER_CONFIRMATION

        @RosettaSynonym(value="AsSpecifiedInMasterConfirmation",
                        source="FpML_5_10")
        public static final DividendAmountTypeEnum AS_SPECIFIED_IN_MASTER_CONFIRMATION
        The Amount is determined as provided in the relevant Master Confirmation.
    • Method Detail

      • values

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

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