Record Class ResponseDto<T>

java.lang.Object
java.lang.Record
com.app.controller.dto.ResponseDto<T>
Type Parameters:
T - the type of the data returned in the response
Record Components:
data - the successful response data, or null if there is an error
error - the error message, or null if the request was successful
public record ResponseDto<T>(T data, String error) extends Record
Generic response wrapper DTO to encapsulate either the successful data or an error message.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ResponseDto(String error)
    Constructs an error response containing an error message.
    ResponseDto(T data)
    Constructs a successful response containing data.
    ResponseDto(T data, String error)
    Creates an instance of a ResponseDto record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    data()
    Returns the value of the data record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    error()
    Returns the value of the error record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    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

    • ResponseDto

      public ResponseDto(T data)
      Constructs a successful response containing data.
      Parameters:
      data - the response data

    • ResponseDto

      public ResponseDto(String error)
      Constructs an error response containing an error message.
      Parameters:
      error - the error message

    • ResponseDto

      public ResponseDto(T data, String error)
      Creates an instance of a ResponseDto record class.
      Parameters:
      data - the value for the data record component
      error - the value for the error 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.

    • data

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

    • error

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