Package org.isda.cdm

Enum OptionTypeEnum

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

    public enum OptionTypeEnum
    extends java.lang.Enum<OptionTypeEnum>
    The enumerated values to specify the type of the option. In FpML, OptionTypeEnum is a union with PutCallEnum, which specifies whether the option is a put or a call.
    Version:
    2.5.4
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CALL
      A call option gives the holder the right to buy the underlying asset by a certain date for a certain price.
      PAYER
      A 'payer' option: If you buy a 'payer' option you have the right but not the obligation to enter into the underlying swap transaction as the 'fixed' rate/price payer and receive float.
      PUT
      A put option gives the holder the right to sell the underlying asset by a certain date for a certain price.
      RECEIVER
      A 'receiver' option: If you buy a 'receiver' option you have the right but not the obligation to enter into the underlying swap transaction as the 'fixed' rate/price receiver and pay float.
      STRADDLE
      A straddle strategy, which involves the simultaneous buying of a put and a call of the same underlier, at the same strike and same expiration date
    • Method Summary

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

      • PUT

        @RosettaSynonym(value="Put",source="FpML_5_10") @RosettaSynonym(value="Put",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="Put",source="DTCC_11_0") @RosettaSynonym(value="Put",source="DTCC_9_0") @RosettaSynonym(value="Put",source="CME_ClearedConfirm_1_17")
        public static final OptionTypeEnum PUT
        A put option gives the holder the right to sell the underlying asset by a certain date for a certain price.
      • CALL

        @RosettaSynonym(value="Call",source="FpML_5_10") @RosettaSynonym(value="Call",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="Call",source="DTCC_11_0") @RosettaSynonym(value="Call",source="DTCC_9_0") @RosettaSynonym(value="Call",source="CME_ClearedConfirm_1_17")
        public static final OptionTypeEnum CALL
        A call option gives the holder the right to buy the underlying asset by a certain date for a certain price.
      • PAYER

        @RosettaSynonym(value="Payer",source="FpML_5_10") @RosettaSynonym(value="Payer",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="Payer",source="DTCC_11_0") @RosettaSynonym(value="Payer",source="DTCC_9_0") @RosettaSynonym(value="Payer",source="CME_ClearedConfirm_1_17")
        public static final OptionTypeEnum PAYER
        A 'payer' option: If you buy a 'payer' option you have the right but not the obligation to enter into the underlying swap transaction as the 'fixed' rate/price payer and receive float.
      • RECEIVER

        @RosettaSynonym(value="Receiver",source="FpML_5_10") @RosettaSynonym(value="Receiver",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="Receiver",source="DTCC_11_0") @RosettaSynonym(value="Receiver",source="DTCC_9_0") @RosettaSynonym(value="Receiver",source="CME_ClearedConfirm_1_17")
        public static final OptionTypeEnum RECEIVER
        A 'receiver' option: If you buy a 'receiver' option you have the right but not the obligation to enter into the underlying swap transaction as the 'fixed' rate/price receiver and pay float.
      • STRADDLE

        @RosettaSynonym(value="Straddle",source="FpML_5_10") @RosettaSynonym(value="Straddle",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="Straddle",source="DTCC_11_0") @RosettaSynonym(value="Straddle",source="DTCC_9_0") @RosettaSynonym(value="Straddle",source="CME_ClearedConfirm_1_17")
        public static final OptionTypeEnum STRADDLE
        A straddle strategy, which involves the simultaneous buying of a put and a call of the same underlier, at the same strike and same expiration date
    • Method Detail

      • values

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

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