Record Class PreTradeLimitChecker.CheckResult

java.lang.Object
java.lang.Record
com.quantfinlib.risk.PreTradeLimitChecker.CheckResult
Enclosing class:
PreTradeLimitChecker
public static record PreTradeLimitChecker.CheckResult(boolean approved, List<String> violations) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    CheckResult(boolean approved, List<String> violations)
    Creates an instance of a CheckResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    approved()
    Returns the value of the approved 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.
    final String
    toString()
    Returns a string representation of this record class.
    List<String>
    violations()
    Returns the value of the violations record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CheckResult

      public CheckResult(boolean approved, List<String> violations)
      Creates an instance of a CheckResult record class.
      Parameters:
      approved - the value for the approved record component
      violations - the value for the violations 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.

    • approved

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

    • violations

      public List<String> violations()
      Returns the value of the violations record component.
      Returns:
      the value of the violations record component