Module utility.exception.mapper
Package uk.co.jasonmarston.kiunzi.utility.exception.mapper.response

Record Class ErrorResponse

java.lang.Object
java.lang.Record
uk.co.jasonmarston.kiunzi.utility.exception.mapper.response.ErrorResponse
Record Components:
code - the application-specific error code identifying the failure category
message - the human-readable description of the error
public record ErrorResponse(String code, String message) extends Record
Generic error payload returned when a request fails without field-level validation details.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    ErrorResponse(String code, String message)
    Creates an instance of a ErrorResponse record class.

  • Method Summary

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ErrorResponse

      public ErrorResponse(String code, String message)
      Creates an instance of a ErrorResponse record class.
      Parameters:
      code - the value for the code 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. 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.

    • code

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

    • message

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