Record Class ConsoleCommand.Outcome

java.lang.Object
java.lang.Record
ai.badmonkey.agentspaces.console.ConsoleCommand.Outcome
Enclosing interface:
ConsoleCommand
public static record ConsoleCommand.Outcome(boolean ok, String message, String entryId) extends Record
The result of executing a command.

  • Constructor Details

    • Outcome

      public Outcome(boolean ok, String message, String entryId)
      Creates an instance of a Outcome record class.
      Parameters:
      ok - the value for the ok record component
      message - the value for the message record component
      entryId - the value for the entryId record component

  • Method Details

    • ok

      public static ConsoleCommand.Outcome ok(String message)
      A success carrying a human-readable message.

    • dispatched

      public static ConsoleCommand.Outcome dispatched(String message, String entryId)
      A success carrying the id of an entry the command dispatched.

    • failed

      public static ConsoleCommand.Outcome failed(String message)
      A failure carrying the reason.

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

    • ok

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

    • message

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

    • entryId

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