Package org.isda.cdm

Enum ReturnTypeEnum

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

    public enum ReturnTypeEnum
    extends java.lang.Enum<ReturnTypeEnum>
    The enumerated values to specify the type of return associated the equity payout.
    Version:
    2.5.4
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DIVIDEND
      Dividend return, i.e.
      PRICE
      Price return, i.e.
      TOTAL
      Total return, i.e.
      VARIANCE
      Variance return.
      VOLATILITY
      Volatility return.
    • Method Summary

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

      • DIVIDEND

        @RosettaSynonym(value="Dividend",
                        source="FpML_5_10")
        public static final ReturnTypeEnum DIVIDEND
        Dividend return, i.e. excluding price variations.
      • PRICE

        @RosettaSynonym(value="Price",
                        source="FpML_5_10")
        public static final ReturnTypeEnum PRICE
        Price return, i.e. excluding dividends.
      • TOTAL

        @RosettaSynonym(value="Total",
                        source="FpML_5_10")
        public static final ReturnTypeEnum TOTAL
        Total return, i.e. including dividend and price components.
      • VARIANCE

        public static final ReturnTypeEnum VARIANCE
        Variance return.
      • VOLATILITY

        public static final ReturnTypeEnum VOLATILITY
        Volatility return.
    • Method Detail

      • values

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

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