Enum SettlementType

  • All Implemented Interfaces:
    Named, NamedEnum, java.io.Serializable, java.lang.Comparable<SettlementType>

    public enum SettlementType
    extends java.lang.Enum<SettlementType>
    implements NamedEnum
    Flag indicating how a financial instrument is to be settled.

    Some financial instruments have a choice of settlement, either by cash or by delivering the underlying instrument that was tracked. For example, a swaption might be cash settled or produce an actual interest rate swap.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CASH
      Cash settlement.
      PHYSICAL
      Physical delivery.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static SettlementType of​(java.lang.String name)
      Obtains an instance from the specified name.
      java.lang.String toString()
      Returns the formatted name of the type.
      static SettlementType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SettlementType[] 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
      • Methods inherited from interface com.opengamma.strata.collect.named.NamedEnum

        getName
    • Enum Constant Detail

      • CASH

        public static final SettlementType CASH
        Cash settlement.

        Cash amount is paid (by the short party to the long party) at expiry.

      • PHYSICAL

        public static final SettlementType PHYSICAL
        Physical delivery.

        The two parties enter into a new financial instrument at expiry.

    • Method Detail

      • values

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

        public static SettlementType 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
      • of

        public static SettlementType of​(java.lang.String name)
        Obtains an instance from the specified name.

        Parsing handles the mixed case form produced by toString() and the upper and lower case variants of the enum constant name.

        Parameters:
        name - the name to parse
        Returns:
        the type
        Throws:
        java.lang.IllegalArgumentException - if the name is not known
      • toString

        public java.lang.String toString()
        Returns the formatted name of the type.
        Overrides:
        toString in class java.lang.Enum<SettlementType>
        Returns:
        the formatted string representing the type