Module quak.framework.web.model
Package io.john.amiscaray.quak.http.response

Record Class Response<T>

java.lang.Object
java.lang.Record
io.john.amiscaray.quak.http.response.Response<T>
Type Parameters:
T - The type of the response body.
Record Components:
headers - The headers as a map.
status - The status code.
body - The response body.
public record Response<T>(Map<String,String> headers, int status, T body) extends Record
Represents an HTTP response.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Response(int status, T body)
    Create a response with no headers.
    Response(Map<String,String> headers, int status, T body)
    Creates an instance of a Response record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    body()
    Returns the value of the body 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.
    Map<String,String>
    headers()
    Returns the value of the headers record component.
    static <T> Response<T>
    of(T body)
    Returns a response with the given response body and status code of 200.
    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

    • Response

      public Response(int status, T body)
      Create a response with no headers.
      Parameters:
      status - The HTTP status code.
      body - The response body.

    • Response

      public Response(Map<String,String> headers, int status, T body)
      Creates an instance of a Response record class.
      Parameters:
      headers - the value for the headers record component
      status - the value for the status record component
      body - the value for the body record component

  • Method Details

    • of

      public static <T> Response<T> of(T body)
      Returns a response with the given response body and status code of 200.
      Type Parameters:
      T - The type of the body.
      Parameters:
      body - The response body.
      Returns:
      A response object.

    • 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.

    • headers

      public Map<String,String> headers()
      Returns the value of the headers record component.
      Returns:
      the value of the headers record component

    • status

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

    • body

      public T body()
      Returns the value of the body record component.
      Returns:
      the value of the body record component