Record Class ApiResponse

java.lang.Object
java.lang.Record
com.pain001.sdk.ApiResponse
Record Components:
status - the HTTP status code
body - the parsed body; JSON null when empty, a JSON string when it was not JSON

public record ApiResponse(int status, com.fasterxml.jackson.databind.JsonNode body) extends Record
  • Constructor Summary

    Constructors
    Constructor
    Description
    ApiResponse(int status, com.fasterxml.jackson.databind.JsonNode body)
    Creates an instance of a ApiResponse record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    Returns the value of the body record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    boolean
    Whether the status is 2xx.
    int
    Returns the value of the status record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • ApiResponse

      public ApiResponse(int status, com.fasterxml.jackson.databind.JsonNode body)
      Creates an instance of a ApiResponse record class.
      Parameters:
      status - the value for the status record component
      body - the value for the body record component
  • Method Details

    • isSuccess

      public boolean isSuccess()
      Whether the status is 2xx.
      Returns:
      true for 200 to 299
    • 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
    • body

      public com.fasterxml.jackson.databind.JsonNode body()
      Returns the value of the body record component.
      Returns:
      the value of the body record component