Package org.teleight.teleightbots.api.objects

Record Class ApiResponse<T>

java.lang.Object
java.lang.Record
org.teleight.teleightbots.api.objects.ApiResponse<T>
All Implemented Interfaces:
Serializable, ApiResult
public record ApiResponse<T>(boolean ok, int errorCode, String errorDescription, ResponseParameters parameters, T result) extends Record implements ApiResult
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    ApiResponse(boolean ok, int errorCode, String errorDescription, ResponseParameters parameters, T result)
    Creates an instance of a ApiResponse record class.

  • Method Summary

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

    • ApiResponse

      public ApiResponse(boolean ok, int errorCode, String errorDescription, ResponseParameters parameters, T result)
      Creates an instance of a ApiResponse record class.
      Parameters:
      ok - the value for the ok record component
      errorCode - the value for the errorCode record component
      errorDescription - the value for the errorDescription record component
      parameters - the value for the parameters record component
      result - the value for the result 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.

    • ok

      public boolean ok()
      Returns the value of the ok record component.
      Returns:
      the value of the ok record component

    • errorCode

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

    • errorDescription

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

    • parameters

      public ResponseParameters parameters()
      Returns the value of the parameters record component.
      Returns:
      the value of the parameters record component

    • result

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