Enum PaymentRelativeTo

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

    public enum PaymentRelativeTo
    extends java.lang.Enum<PaymentRelativeTo>
    implements NamedEnum
    The base date that each payment is made relative to.

    When calculating the payment date for a swap leg, the date is calculated relative to another date. The other date is specified by this enum.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      PERIOD_END
      The payment is made relative to the end of each payment period.
      PERIOD_START
      The payment is made relative to the start of each payment period.
    • Method Summary

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

      • PERIOD_START

        public static final PaymentRelativeTo PERIOD_START
        The payment is made relative to the start of each payment period.

        The payment date is relative to the start date of the first accrual period within the payment period, as adjusted by business day conventions.

        This can be referred to as "payment in advance".

      • PERIOD_END

        public static final PaymentRelativeTo PERIOD_END
        The payment is made relative to the end of each payment period.

        The payment date is relative to the end date of the last accrual period within the payment period, as adjusted by business day conventions.

        This can be referred to as "payment in arrears".

    • Method Detail

      • values

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

        public static PaymentRelativeTo 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 PaymentRelativeTo 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<PaymentRelativeTo>
        Returns:
        the formatted string representing the type