Package net.thauvin.erik.frankfurter.models

Record Class ErrorResponse

java.lang.Object
java.lang.Record
net.thauvin.erik.frankfurter.models.ErrorResponse
Record Components:
status - the HTTP status code returned by the API
message - the error message, or null if none was provided
All Implemented Interfaces:
CurrenciesResult, CurrencyResult, ProvidersResult, RateResult, RatesResult
public record ErrorResponse(int status, String message) extends Record implements CurrenciesResult, CurrencyResult, ProvidersResult, RatesResult, RateResult
Represents an error response returned by the Frankfurter API.

This type models the structure of error payloads returned by any endpoint. It is used when the API responds with a non‑200 HTTP status code. Instances may originate from parsed JSON or from fallback text when parsing fails.

ErrorResponse participates in all result hierarchies (CurrenciesResult, CurrencyResult, ProvidersResult, RatesResult, RateResult) so callers can uniformly handle success and error outcomes.

Since:
1.0
Author:
Erik C. Thauvin

  • Constructor Summary

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

  • Method Summary

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

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ErrorResponse

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

    • status

      public int status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component

    • message

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