Package com.monkey.ultimatebot.api.model.runtime

Record Class BotOperationResult

java.lang.Object
java.lang.Record
com.monkey.ultimatebot.api.model.runtime.BotOperationResult
Record Components:
success - true when the operation completed successfully
message - human-readable operation message (success or failure reason)
snapshot - optional bot snapshot associated with the operation
public record BotOperationResult(boolean success, String message, @Nullable BotSnapshot snapshot) extends Record
Standard result object for bot operations.

  • Constructor Details

    • BotOperationResult

      public BotOperationResult(boolean success, String message, @Nullable BotSnapshot snapshot)
      Creates an instance of a BotOperationResult record class.
      Parameters:
      success - the value for the success record component
      message - the value for the message record component
      snapshot - the value for the snapshot record component

  • Method Details

    • success

      public static BotOperationResult success(String message, @Nullable BotSnapshot snapshot)
      Creates a successful operation result.
      Parameters:
      message - success message
      snapshot - bot snapshot after operation, may be null
      Returns:
      success result

    • failure

      public static BotOperationResult failure(String message)
      Creates a failed operation result.
      Parameters:
      message - failure reason
      Returns:
      failure result

    • snapshotOptional

      public Optional<BotSnapshot> snapshotOptional()
      Returns snapshot as an optional.
      Returns:
      optional snapshot

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

    • message

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

    • snapshot

      public @Nullable BotSnapshot snapshot()
      Returns the value of the snapshot record component.
      Returns:
      the value of the snapshot record component