Record Class MultiCurrencyExposureSimulator.FxForward

java.lang.Object

java.lang.Record

com.quantfinlib.credit.MultiCurrencyExposureSimulator.FxForward

Record Components:

pair - index into MultiCurrencyExposureSimulator.Market.foreign()

terms - forward terms (notional in that foreign currency)

Enclosing class:

MultiCurrencyExposureSimulator

public static record MultiCurrencyExposureSimulator.FxForward(int pair, MultiCurrencyExposureSimulator.FxForwardTerms terms)
extends Record

An FX forward on one pair.

Constructor Summary

Constructors

Constructor	Description
FxForward(int pair, MultiCurrencyExposureSimulator.FxForwardTerms terms)	Validates.

Method Summary

Modifier and Type	Method	Description
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.
int	pair()	Returns the value of the pair record component.
MultiCurrencyExposureSimulator.FxForwardTerms	terms()	Returns the value of the terms record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

FxForward

public FxForward(int pair,
 MultiCurrencyExposureSimulator.FxForwardTerms terms)

Validates.

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.

pair

public int pair()

Returns the value of the pair record component.

Returns:

the value of the pair record component

terms

public MultiCurrencyExposureSimulator.FxForwardTerms terms()

Returns the value of the terms record component.

Returns:

the value of the terms record component