Package net.finmath.smartcontract.product.xml

Enum Class DividendDateReferenceEnum

java.lang.Object
java.lang.Enum<DividendDateReferenceEnum>
net.finmath.smartcontract.product.xml.DividendDateReferenceEnum
All Implemented Interfaces:
Serializable, Comparable<DividendDateReferenceEnum>, Constable
public enum DividendDateReferenceEnum extends Enum<DividendDateReferenceEnum>

Java class for DividendDateReferenceEnum.

The following schema fragment specifies the expected content contained within this class. 

 <simpleType name="DividendDateReferenceEnum">
   <restriction base="{http://www.w3.org/2001/XMLSchema}token">
     <enumeration value="ExDate"/>
     <enumeration value="DividendPaymentDate"/>
     <enumeration value="DividendValuationDate"/>
     <enumeration value="RecordDate"/>
     <enumeration value="TerminationDate"/>
     <enumeration value="EquityPaymentDate"/>
     <enumeration value="FollowingPaymentDate"/>
     <enumeration value="AdHocDate"/>
     <enumeration value="CumulativeEquityPaid"/>
     <enumeration value="CumulativeLiborPaid"/>
     <enumeration value="CumulativeEquityExDiv"/>
     <enumeration value="CumulativeLiborExDiv"/>
     <enumeration value="SharePayment"/>
     <enumeration value="CashSettlementPaymentDate"/>
     <enumeration value="FloatingAmountPaymentDate"/>
     <enumeration value="CashSettlePaymentDateExDiv"/>
     <enumeration value="CashSettlePaymentDateIssuerPayment"/>
     <enumeration value="ExDividendPaymentDate"/>
   </restriction>
 </simpleType>

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AD_HOC_DATE
    The dividend date will be specified ad hoc by the parties, typically on the dividend ex-date
    CASH_SETTLE_PAYMENT_DATE_EX_DIV
    If "Dividend Payment Date(s)" is specified in the Transaction Supplement as "Cash Settlement Payment Date – Ex Dividend", then the Dividend Payment Date in respect of a Dividend Amount shall be the Cash Settlement Payment Date relating to the end of the Dividend Period during which the Shares commenced trading “ex” the relevant dividend on the Exchange.
    CASH_SETTLE_PAYMENT_DATE_ISSUER_PAYMENT
    If "Dividend Payment Date(s)" is specified in the Transaction Supplement as "Cash Settlement Payment Date – Issuer Payment", then the Dividend Payment Date in respect of a Dividend Amount shall be the Cash Settlement Payment Date relating to the end of the Dividend Period during which the issuer pays the relevant dividend to a holder of record provided that in the case where the Equity Amount Payer is the party specified to be the sole Hedging Party and the Hedging Party has not received the Dividend Amount by such date, then the date falling a number of Currency Business Days as specified in the Cash Settlement Payment Date after actual receipt by the Hedging Party of the Received Ex Amount or Paid Ex Amount (as applicable).
    CASH_SETTLEMENT_PAYMENT_DATE
    If "Dividend Payment Date(s)" is specified in the Transaction Supplement as "Cash Settlement Payment Date", then the Dividend Payment Date in respect of a Dividend Amount shall be the Cash Settlement Payment Date relating to the end of the Dividend Period during which the Shares commenced trading "ex" the relevant dividend on the Exchange
    CUMULATIVE_EQUITY_EX_DIV
    Total of dividends which go ex, paid on next following Cash Settlement Payment Date, which is immediately following the Dividend Period during which the Shares commence trading ex-dividend on the Exchange
    CUMULATIVE_EQUITY_PAID
    Total of paid dividends, paid on next following Cash Settlement Payment Date, which is immediately following the Dividend Period during which the dividend is paid by the Issuer to the holders of record of a Share.
    CUMULATIVE_LIBOR_EX_DIV
    Total of dividends which go ex, paid on next following Payment Date, which is immediately following the Dividend Period during which the Shares commence trading ex-dividend on the Exchange, or where the date on which the Shares commence trading ex-dividend is a Payment Date, such Payment Date.
    CUMULATIVE_LIBOR_PAID
    Total of paid dividends, paid on next following Payment Date, which is immediately following the Dividend Period during which the dividend is paid by the Issuer to the holders of record of a Share.
    DIVIDEND_PAYMENT_DATE
    Date on which the dividend will be paid by the issuer.
    DIVIDEND_VALUATION_DATE
    In respect of each Dividend Period, number of days offset from the relevant Dividend Valuation Date.
    EQUITY_PAYMENT_DATE
    Equity payment date of the swap.
    EX_DATE
    Date on which a holder of the security is entitled to the dividend.
    EX_DIVIDEND_PAYMENT_DATE
    If "Dividend Payment Date(s)" is specified in the Transaction Supplement as "Ex-dividend Payment Date", then the Dividend Payment Date in respect of a Dividend Amount shall be the number of Currency Business Days as provided in the Transaction Supplement following the day on which the Shares commence trading ‘ex’ on the Exchange.
    FLOATING_AMOUNT_PAYMENT_DATE
    If "Dividend Payment Date(s)" is specified in the Transaction Supplement as "Floating Amount Payment Date", then the Dividend Payment Date in respect of a Dividend Amount shall be the first Payment Date falling at least one Settlement Cycle after the date that the Shares have commenced trading "ex" the relevant dividend on the Exchange.
    FOLLOWING_PAYMENT_DATE
    The next payment date of the swap.
    RECORD_DATE
    Date on which the dividend will be recorded in the books of the paying agent.
    SHARE_PAYMENT
    If "Dividend Payment Date(s)" is specified in the Transaction Supplement as "Share Payment", then the Dividend Payment Date in respect of a Dividend Amount shall fall on a date on or before the date that is two (or any other number that is specified in the Transaction Supplement) Currency Business Days following the day on which the Issuer of the Shares pays the relevant dividend to holders of record of the Shares
    TERMINATION_DATE
    Termination date of the swap.

  • Method Summary

    Modifier and Type
    Method
    Description
    static DividendDateReferenceEnum
    fromValue​(String v)
     
    String
    value()
     
    static DividendDateReferenceEnum
    valueOf​(String name)
    Returns the enum constant of this class with the specified name.
    static DividendDateReferenceEnum[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • EX_DATE

      public static final DividendDateReferenceEnum EX_DATE
      Date on which a holder of the security is entitled to the dividend.

    • DIVIDEND_PAYMENT_DATE

      public static final DividendDateReferenceEnum DIVIDEND_PAYMENT_DATE
      Date on which the dividend will be paid by the issuer.

    • DIVIDEND_VALUATION_DATE

      public static final DividendDateReferenceEnum DIVIDEND_VALUATION_DATE
      In respect of each Dividend Period, number of days offset from the relevant Dividend Valuation Date.

    • RECORD_DATE

      public static final DividendDateReferenceEnum RECORD_DATE
      Date on which the dividend will be recorded in the books of the paying agent.

    • TERMINATION_DATE

      public static final DividendDateReferenceEnum TERMINATION_DATE
      Termination date of the swap.

    • EQUITY_PAYMENT_DATE

      public static final DividendDateReferenceEnum EQUITY_PAYMENT_DATE
      Equity payment date of the swap.

    • FOLLOWING_PAYMENT_DATE

      public static final DividendDateReferenceEnum FOLLOWING_PAYMENT_DATE
      The next payment date of the swap.

    • AD_HOC_DATE

      public static final DividendDateReferenceEnum AD_HOC_DATE
      The dividend date will be specified ad hoc by the parties, typically on the dividend ex-date

    • CUMULATIVE_EQUITY_PAID

      public static final DividendDateReferenceEnum CUMULATIVE_EQUITY_PAID
      Total of paid dividends, paid on next following Cash Settlement Payment Date, which is immediately following the Dividend Period during which the dividend is paid by the Issuer to the holders of record of a Share.

    • CUMULATIVE_LIBOR_PAID

      public static final DividendDateReferenceEnum CUMULATIVE_LIBOR_PAID
      Total of paid dividends, paid on next following Payment Date, which is immediately following the Dividend Period during which the dividend is paid by the Issuer to the holders of record of a Share.

    • CUMULATIVE_EQUITY_EX_DIV

      public static final DividendDateReferenceEnum CUMULATIVE_EQUITY_EX_DIV
      Total of dividends which go ex, paid on next following Cash Settlement Payment Date, which is immediately following the Dividend Period during which the Shares commence trading ex-dividend on the Exchange

    • CUMULATIVE_LIBOR_EX_DIV

      public static final DividendDateReferenceEnum CUMULATIVE_LIBOR_EX_DIV
      Total of dividends which go ex, paid on next following Payment Date, which is immediately following the Dividend Period during which the Shares commence trading ex-dividend on the Exchange, or where the date on which the Shares commence trading ex-dividend is a Payment Date, such Payment Date.

    • SHARE_PAYMENT

      public static final DividendDateReferenceEnum SHARE_PAYMENT
      If "Dividend Payment Date(s)" is specified in the Transaction Supplement as "Share Payment", then the Dividend Payment Date in respect of a Dividend Amount shall fall on a date on or before the date that is two (or any other number that is specified in the Transaction Supplement) Currency Business Days following the day on which the Issuer of the Shares pays the relevant dividend to holders of record of the Shares

    • CASH_SETTLEMENT_PAYMENT_DATE

      public static final DividendDateReferenceEnum CASH_SETTLEMENT_PAYMENT_DATE
      If "Dividend Payment Date(s)" is specified in the Transaction Supplement as "Cash Settlement Payment Date", then the Dividend Payment Date in respect of a Dividend Amount shall be the Cash Settlement Payment Date relating to the end of the Dividend Period during which the Shares commenced trading "ex" the relevant dividend on the Exchange

    • FLOATING_AMOUNT_PAYMENT_DATE

      public static final DividendDateReferenceEnum FLOATING_AMOUNT_PAYMENT_DATE
      If "Dividend Payment Date(s)" is specified in the Transaction Supplement as "Floating Amount Payment Date", then the Dividend Payment Date in respect of a Dividend Amount shall be the first Payment Date falling at least one Settlement Cycle after the date that the Shares have commenced trading "ex" the relevant dividend on the Exchange.

    • CASH_SETTLE_PAYMENT_DATE_EX_DIV

      public static final DividendDateReferenceEnum CASH_SETTLE_PAYMENT_DATE_EX_DIV
      If "Dividend Payment Date(s)" is specified in the Transaction Supplement as "Cash Settlement Payment Date – Ex Dividend", then the Dividend Payment Date in respect of a Dividend Amount shall be the Cash Settlement Payment Date relating to the end of the Dividend Period during which the Shares commenced trading “ex” the relevant dividend on the Exchange.

    • CASH_SETTLE_PAYMENT_DATE_ISSUER_PAYMENT

      public static final DividendDateReferenceEnum CASH_SETTLE_PAYMENT_DATE_ISSUER_PAYMENT
      If "Dividend Payment Date(s)" is specified in the Transaction Supplement as "Cash Settlement Payment Date – Issuer Payment", then the Dividend Payment Date in respect of a Dividend Amount shall be the Cash Settlement Payment Date relating to the end of the Dividend Period during which the issuer pays the relevant dividend to a holder of record provided that in the case where the Equity Amount Payer is the party specified to be the sole Hedging Party and the Hedging Party has not received the Dividend Amount by such date, then the date falling a number of Currency Business Days as specified in the Cash Settlement Payment Date after actual receipt by the Hedging Party of the Received Ex Amount or Paid Ex Amount (as applicable).

    • EX_DIVIDEND_PAYMENT_DATE

      public static final DividendDateReferenceEnum EX_DIVIDEND_PAYMENT_DATE
      If "Dividend Payment Date(s)" is specified in the Transaction Supplement as "Ex-dividend Payment Date", then the Dividend Payment Date in respect of a Dividend Amount shall be the number of Currency Business Days as provided in the Transaction Supplement following the day on which the Shares commence trading ‘ex’ on the Exchange.

  • Method Details

    • values

      public static DividendDateReferenceEnum[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static DividendDateReferenceEnum valueOf​(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • value

      public String value()

    • fromValue

      public static DividendDateReferenceEnum fromValue​(String v)