Record Class HistoricalLightweightMainAggregationEvent.Bbo

java.lang.Object
java.lang.Record
velox.api.layer1.datastructure.events.dynamichistory.HistoricalLightweightMainAggregationEvent.Bbo
Enclosing class:
HistoricalLightweightMainAggregationEvent

public static record HistoricalLightweightMainAggregationEvent.Bbo(Long bestBidOrNull, Long bestAskOrNull) extends Record
The best bid and ask in the block's time window.

Values are stored in raw (unconverted) units: prices are expressed in pips, so they must be multiplied by InstrumentInfo.pips to get the actual price.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Bbo(Long bestBidOrNull, Long bestAskOrNull)
    Creates an instance of a Bbo record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the value of the bestAskOrNull record component.
    Returns the value of the bestBidOrNull record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    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

    • Bbo

      public Bbo(Long bestBidOrNull, Long bestAskOrNull)
      Creates an instance of a Bbo record class.
      Parameters:
      bestBidOrNull - the value for the bestBidOrNull record component
      bestAskOrNull - the value for the bestAskOrNull 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 Objects::equals(Object,Object).
      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.
    • bestBidOrNull

      public Long bestBidOrNull()
      Returns the value of the bestBidOrNull record component.
      Returns:
      the value of the bestBidOrNull record component
    • bestAskOrNull

      public Long bestAskOrNull()
      Returns the value of the bestAskOrNull record component.
      Returns:
      the value of the bestAskOrNull record component