Package com.opengamma.strata.product.common

Enum PayReceive

  • All Implemented Interfaces:
    Named, NamedEnum, Serializable, Comparable<PayReceive>
    public enum PayReceive
extends Enum<PayReceive>
implements NamedEnum
    Flag indicating whether a financial instrument is "pay" or "receive".

    Specifies the direction of payments. For example, a swap typically has two legs, a pay leg, where payments are made to the counterparty, and a receive leg, where payments are received.

    • Enum Constant Detail

      • RECEIVE

        public static final PayReceive RECEIVE
        Receive.

    • Method Detail

      • values

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

      • valueOf

        public static PayReceive valueOf​(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:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • of

        public static PayReceive of​(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:
        IllegalArgumentException - if the name is not known

      • ofPay

        public static PayReceive ofPay​(boolean isPay)
        Converts a boolean "is pay" flag to the enum value.
        Parameters:
        isPay - the pay flag, true for pay, false for receive
        Returns:
        the equivalent enum

      • ofSignedAmount

        public static PayReceive ofSignedAmount​(double amount)
        Converts a signed amount to the enum value.

        A negative value will return 'Pay'. A positive value will return 'Receive'. This effectively parses the result of normalize(double).

        Parameters:
        amount - the amount to check
        Returns:
        the equivalent enum

      • normalize

        public double normalize​(double amount)
        Normalizes the specified notional amount using this pay/receive rule.

        This returns a negative signed amount if this is 'Pay', and a positive signed amount if this is 'Receive'. This effectively normalizes the input notional to the pay/receive sign conventions of this library. The negative form of zero will never be returned.

        Parameters:
        amount - the amount to adjust
        Returns:
        the adjusted amount

      • normalize

        public CurrencyAmount normalize​(CurrencyAmount amount)
        Normalizes the specified amount using this pay/receive rule.

        This returns a negative signed amount if this is 'Pay', and a positive signed amount if this is 'Receive'. This effectively normalizes the input notional to the pay/receive sign conventions of this library. The negative form of zero will never be returned.

        Parameters:
        amount - the amount to adjust
        Returns:
        the adjusted amount

      • isPay

        public boolean isPay()
        Checks if the type is 'Pay'.
        Returns:
        true if pay, false if receive

      • isReceive

        public boolean isReceive()
        Checks if the type is 'Receive'.
        Returns:
        true if receive, false if pay

      • opposite

        public PayReceive opposite()
        Supplies the opposite of this value.
        Returns:
        the opposite value

      • toString

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