Record Class FixAnalyzer.FixImpactReport

java.lang.Object
java.lang.Record
com.quantfinlib.regulatory.FixAnalyzer.FixImpactReport
Enclosing class:
FixAnalyzer

public static record FixAnalyzer.FixImpactReport(double fixRate, double runUpBps, double reversionBps, double participationShare, long netFlow, boolean flagged) extends Record
  • Constructor Summary

    Constructors
    Constructor
    Description
    FixImpactReport(double fixRate, double runUpBps, double reversionBps, double participationShare, long netFlow, boolean flagged)
    Creates an instance of a FixImpactReport record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    double
    Returns the value of the fixRate record component.
    boolean
    Returns the value of the flagged record component.
    final int
    Returns a hash code value for this object.
    long
    Returns the value of the netFlow record component.
    double
    Returns the value of the participationShare record component.
    double
    Returns the value of the reversionBps record component.
    double
    Returns the value of the runUpBps record component.
    final String
    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

    • FixImpactReport

      public FixImpactReport(double fixRate, double runUpBps, double reversionBps, double participationShare, long netFlow, boolean flagged)
      Creates an instance of a FixImpactReport record class.
      Parameters:
      fixRate - the value for the fixRate record component
      runUpBps - the value for the runUpBps record component
      reversionBps - the value for the reversionBps record component
      participationShare - the value for the participationShare record component
      netFlow - the value for the netFlow record component
      flagged - the value for the flagged 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. All components in this record class 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.
    • fixRate

      public double fixRate()
      Returns the value of the fixRate record component.
      Returns:
      the value of the fixRate record component
    • runUpBps

      public double runUpBps()
      Returns the value of the runUpBps record component.
      Returns:
      the value of the runUpBps record component
    • reversionBps

      public double reversionBps()
      Returns the value of the reversionBps record component.
      Returns:
      the value of the reversionBps record component
    • participationShare

      public double participationShare()
      Returns the value of the participationShare record component.
      Returns:
      the value of the participationShare record component
    • netFlow

      public long netFlow()
      Returns the value of the netFlow record component.
      Returns:
      the value of the netFlow record component
    • flagged

      public boolean flagged()
      Returns the value of the flagged record component.
      Returns:
      the value of the flagged record component