Record Class ScriptHealth

java.lang.Object
java.lang.Record
com.botwithus.bot.api.runtime.ScriptHealth
public record ScriptHealth(Optional<LastCrash> lastCrash, long totalCrashes) extends Record
Immutable snapshot of a script's failure history. Held atomically by the runtime; mutated only by replacing the whole record via withCrash(LastCrash).

lastCrash is empty when the script has never thrown; otherwise it holds the most recent failure. totalCrashes counts every failure observed since the runner was constructed (not just the current lifetime, since the same ScriptRunner can be restarted).

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final ScriptHealth
    HEALTHY
    Sentinel for a never-crashed script.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ScriptHealth(Optional<LastCrash> lastCrash, long totalCrashes)
    Creates an instance of a ScriptHealth 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.
    Optional<LastCrash>
    lastCrash()
    Returns the value of the lastCrash record component.
    final String
    toString()
    Returns a string representation of this record class.
    long
    totalCrashes()
    Returns the value of the totalCrashes record component.
    ScriptHealth
    withCrash(LastCrash crash)
    Returns a new ScriptHealth with the given crash recorded and totalCrashes incremented by one.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • HEALTHY

      public static final ScriptHealth HEALTHY
      Sentinel for a never-crashed script.

  • Constructor Details

    • ScriptHealth

      public ScriptHealth(Optional<LastCrash> lastCrash, long totalCrashes)
      Creates an instance of a ScriptHealth record class.
      Parameters:
      lastCrash - the value for the lastCrash record component
      totalCrashes - the value for the totalCrashes record component

  • Method Details

    • withCrash

      public ScriptHealth withCrash(LastCrash crash)
      Returns a new ScriptHealth with the given crash recorded and totalCrashes incremented by one. The receiver is unmodified.

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

    • lastCrash

      public Optional<LastCrash> lastCrash()
      Returns the value of the lastCrash record component.
      Returns:
      the value of the lastCrash record component

    • totalCrashes

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