Record Class Indicators.Donchian

java.lang.Object
java.lang.Record
com.quantfinlib.indicators.Indicators.Donchian
Enclosing class:
Indicators
public static record Indicators.Donchian(double[] upper, double[] middle, double[] lower) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    Donchian(double[] upper, double[] middle, double[] lower)
    Creates an instance of a Donchian record class.

  • 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.
    double[]
    lower()
    Returns the value of the lower record component.
    double[]
    middle()
    Returns the value of the middle record component.
    final String
    toString()
    Returns a string representation of this record class.
    double[]
    upper()
    Returns the value of the upper record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Donchian

      public Donchian(double[] upper, double[] middle, double[] lower)
      Creates an instance of a Donchian record class.
      Parameters:
      upper - the value for the upper record component
      middle - the value for the middle record component
      lower - the value for the lower 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.

    • upper

      public double[] upper()
      Returns the value of the upper record component.
      Returns:
      the value of the upper record component

    • middle

      public double[] middle()
      Returns the value of the middle record component.
      Returns:
      the value of the middle record component

    • lower

      public double[] lower()
      Returns the value of the lower record component.
      Returns:
      the value of the lower record component