Package br.com.selfmaintenance.utils.responses

Record Class ApiResponse

java.lang.Object

java.lang.Record

br.com.selfmaintenance.utils.responses.ApiResponse

public record ApiResponse(int status, String mensagem, Object dados, DadosErroResponse erro)
extends Record

[ApiResponse] é a classe que representa a resposta padrão da API.

Version:

1.0.0

Constructor Summary

Constructors

Constructor	Description
ApiResponse(int status, String mensagem)
ApiResponse(int status, String mensagem, DadosErroResponse erro)
ApiResponse(int status, String mensagem, Object dados)
ApiResponse(int status, String mensagem, Object dados, DadosErroResponse erro)	Creates an instance of a ApiResponse record class.

Method Summary

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

ApiResponse

public ApiResponse(int status,
 String mensagem)

ApiResponse

public ApiResponse(int status,
 String mensagem,
 Object dados)

ApiResponse

public ApiResponse(int status,
 String mensagem,
 DadosErroResponse erro)

ApiResponse

public ApiResponse(int status,
 String mensagem,
 Object dados,
 DadosErroResponse erro)

Creates an instance of a ApiResponse record class.

Parameters:

status - the value for the status record component

mensagem - the value for the mensagem record component

dados - the value for the dados record component

erro - the value for the erro 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

mensagem

public String mensagem()

Returns the value of the mensagem record component.

Returns:

the value of the mensagem record component

dados

public Object dados()

Returns the value of the dados record component.

Returns:

the value of the dados record component

erro

public DadosErroResponse erro()

Returns the value of the erro record component.

Returns:

the value of the erro record component