Record Class LegConvention.Period

java.lang.Object
java.lang.Record
com.quantfinlib.rates.LegConvention.Period
Record Components:
accrualStart - adjusted accrual start
accrualEnd - adjusted accrual end
paymentDate - payment date (accrual end plus the payment lag)
yearFraction - accrual year fraction under the leg day count
Enclosing class:
LegConvention
public static record LegConvention.Period(LocalDate accrualStart, LocalDate accrualEnd, LocalDate paymentDate, double yearFraction) extends Record
One accrual period.

  • Constructor Details

    • Period

      public Period(LocalDate accrualStart, LocalDate accrualEnd, LocalDate paymentDate, double yearFraction)
      Creates an instance of a Period record class.
      Parameters:
      accrualStart - the value for the accrualStart record component
      accrualEnd - the value for the accrualEnd record component
      paymentDate - the value for the paymentDate record component
      yearFraction - the value for the yearFraction 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.

    • accrualStart

      public LocalDate accrualStart()
      Returns the value of the accrualStart record component.
      Returns:
      the value of the accrualStart record component

    • accrualEnd

      public LocalDate accrualEnd()
      Returns the value of the accrualEnd record component.
      Returns:
      the value of the accrualEnd record component

    • paymentDate

      public LocalDate paymentDate()
      Returns the value of the paymentDate record component.
      Returns:
      the value of the paymentDate record component

    • yearFraction

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