Record Class FxHedger.FxExposure

java.lang.Object
java.lang.Record
com.quantfinlib.hedging.FxHedger.FxExposure
Enclosing class:
FxHedger
public static record FxHedger.FxExposure(String currency, double amountBase) extends Record
One currency exposure, signed, in base-currency terms.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FxExposure(String currency, double amountBase)
    Creates an instance of a FxExposure record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    amountBase()
    Returns the value of the amountBase record component.
    String
    currency()
    Returns the value of the currency record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • FxExposure

      public FxExposure(String currency, double amountBase)
      Creates an instance of a FxExposure record class.
      Parameters:
      currency - the value for the currency record component
      amountBase - the value for the amountBase record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • currency

      public String currency()
      Returns the value of the currency record component.
      Returns:
      the value of the currency record component

    • amountBase

      public double amountBase()
      Returns the value of the amountBase record component.
      Returns:
      the value of the amountBase record component