Record Class CheckResult

java.lang.Object
java.lang.Record
frc.spectrumLib.checks.CheckResult
Record Components:
status - the verdict
reason - one line: what was found, with the numbers
public record CheckResult(CheckResult.Status status, String reason) extends Record
One check's verdict and the reason for it, in words a drive team can act on.

  • Constructor Details

    • CheckResult

      public CheckResult(CheckResult.Status status, String reason)
      Creates an instance of a CheckResult record class.
      Parameters:
      status - the value for the status record component
      reason - the value for the reason record component

  • Method Details

    • skip

      public static CheckResult skip(String reason)

    • pass

      public static CheckResult pass(String reason)

    • warn

      public static CheckResult warn(String reason)

    • fail

      public static CheckResult fail(String reason)

    • isFail

      public boolean isFail()

    • isWarn

      public boolean isWarn()

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

    • status

      public CheckResult.Status status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component

    • reason

      public String reason()
      Returns the value of the reason record component.
      Returns:
      the value of the reason record component