Record Class MessageError

java.lang.Object
java.lang.Record
dev.zwazel.internal.message.data.MessageError
Record Components:
error - The type of error that occurred.
errorMessage - The message describing the error.
All Implemented Interfaces:
MessageData
public record MessageError(dev.zwazel.internal.message.data.MessageError.ErrorTypes error, String errorMessage) extends Record implements MessageData
Represents an error message from the server. Received when an error occurs.

  • Constructor Details

    • MessageError

      public MessageError(dev.zwazel.internal.message.data.MessageError.ErrorTypes error, String errorMessage)
      Creates an instance of a MessageError record class.
      Parameters:
      error - the value for the error record component
      errorMessage - the value for the errorMessage record component

  • Method Details

    • applyOnReceive

      public boolean applyOnReceive(InternalGameWorld internalWorld)
      Prints the error message to the console.
      Specified by:
      applyOnReceive in interface MessageData
      Parameters:
      internalWorld - the world
      Returns:
      true, meaning the bot can also handle this message if it wants to.

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • error

      public dev.zwazel.internal.message.data.MessageError.ErrorTypes error()
      Returns the value of the error record component.
      Returns:
      the value of the error record component

    • errorMessage

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