Module concord_core

Record Class Error

java.lang.Object
java.lang.Record
nl.andrewl.concord_core.msg.types.Error
Record Components:
level - The severity level of the error.
message - A message indicating what went wrong.
All Implemented Interfaces:
Message

public record Error(Error.Level level, String message) extends Record implements Message
Error message which can be sent between either the server or client to indicate an unsavory situation.
  • Field Details

    • level

      private final Error.Level level
      The field for the level record component.
    • message

      private final String message
      The field for the message record component.
  • Constructor Details

    • Error

      public Error(Error.Level level, String message)
      Creates an instance of a Error record class.
      Parameters:
      level - the value for the level record component
      message - the value for the message record component
  • Method Details

    • warning

      public static Error warning(String message)
      Creates a warning message.
      Parameters:
      message - The message text.
      Returns:
      A warning-level error message.
    • error

      public static Error error(String message)
      Creates an error message.
      Parameters:
      message - The message text.
      Returns:
      An error-level error message.
    • 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.
    • level

      public Error.Level level()
      Returns the value of the level record component.
      Returns:
      the value of the level record component
    • message

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