Record Class ClientOrchestrator.OpResult

java.lang.Object
java.lang.Record
com.botwithus.bot.api.script.ClientOrchestrator.OpResult
Enclosing interface:
ClientOrchestrator
public static record ClientOrchestrator.OpResult(boolean success, String clientName, String scriptName, String message) extends Record
Result of a script operation on a specific client.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpResult(boolean success, String clientName, String scriptName, String message)
    Creates an instance of a OpResult record class.

  • Method Summary

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

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • OpResult

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

    • success

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

    • 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

    • message

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