Record Class ClientOrchestrator.ScriptStatusEntry

java.lang.Object
java.lang.Record
com.botwithus.bot.api.script.ClientOrchestrator.ScriptStatusEntry
Enclosing interface:
ClientOrchestrator
public static record ClientOrchestrator.ScriptStatusEntry(String clientName, String scriptName, String version, boolean running, boolean clientAlive) extends Record
Snapshot of a script's state on a specific client.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ScriptStatusEntry(String clientName, String scriptName, String version, boolean running, boolean clientAlive)
    Creates an instance of a ScriptStatusEntry record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    clientAlive()
    Returns the value of the clientAlive record component.
    String
    clientName()
    Returns the value of the clientName 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.
    boolean
    running()
    Returns the value of the running record component.
    String
    scriptName()
    Returns the value of the scriptName record component.
    final String
    toString()
    Returns a string representation of this record class.
    String
    version()
    Returns the value of the version record component.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ScriptStatusEntry

      public ScriptStatusEntry(String clientName, String scriptName, String version, boolean running, boolean clientAlive)
      Creates an instance of a ScriptStatusEntry record class.
      Parameters:
      clientName - the value for the clientName record component
      scriptName - the value for the scriptName record component
      version - the value for the version record component
      running - the value for the running record component
      clientAlive - the value for the clientAlive 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.

    • clientName

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

    • scriptName

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

    • version

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

    • running

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

    • clientAlive

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