Package org.isda.cdm

Enum DividendEntitlementEnum

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

    public enum DividendEntitlementEnum
    extends java.lang.Enum<DividendEntitlementEnum>
    The enumerated values to specify the date on which the receiver of the equity payout is entitled to the dividend.
    Version:
    2.5.4
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      EX_DATE
      Dividend entitlement is on the dividend ex-date.
      RECORD_DATE
      Dividend entitlement is on the dividend record date.
    • Method Summary

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

      • EX_DATE

        @RosettaSynonym(value="ExDate",
                        source="FpML_5_10")
        public static final DividendEntitlementEnum EX_DATE
        Dividend entitlement is on the dividend ex-date.
      • RECORD_DATE

        @RosettaSynonym(value="RecordDate",
                        source="FIX_5_0_SP2")
        public static final DividendEntitlementEnum RECORD_DATE
        Dividend entitlement is on the dividend record date.
    • Method Detail

      • values

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

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