Record Class Bar

java.lang.Object
java.lang.Record
com.quantfinlib.core.Bar
public record Bar(long timestamp, double open, double high, double low, double close, double volume) extends Record
Immutable OHLCV bar. Timestamp is epoch milliseconds.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Bar(long timestamp, double open, double high, double low, double close, double volume)
    Creates an instance of a Bar record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    close()
    Returns the value of the close 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.
    double
    high()
    Returns the value of the high record component.
    boolean
    isBullish()
     
    double
    low()
    Returns the value of the low record component.
    double
    open()
    Returns the value of the open record component.
    double
    range()
     
    long
    timestamp()
    Returns the value of the timestamp record component.
    final String
    toString()
    Returns a string representation of this record class.
    double
    typicalPrice()
     
    double
    volume()
    Returns the value of the volume record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Bar

      public Bar(long timestamp, double open, double high, double low, double close, double volume)
      Creates an instance of a Bar record class.
      Parameters:
      timestamp - the value for the timestamp record component
      open - the value for the open record component
      high - the value for the high record component
      low - the value for the low record component
      close - the value for the close record component
      volume - the value for the volume record component

  • Method Details

    • typicalPrice

      public double typicalPrice()

    • range

      public double range()

    • isBullish

      public boolean isBullish()

    • 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.

    • timestamp

      public long timestamp()
      Returns the value of the timestamp record component.
      Returns:
      the value of the timestamp record component

    • open

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

    • high

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

    • low

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

    • close

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

    • volume

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