Package pro.nikolaev.restutils.dto

Record Class ApiError

java.lang.Object

java.lang.Record

pro.nikolaev.restutils.dto.ApiError

Record Components:

message - a brief error description

details - details which may describe either reason for an error, ways of resolution to an error or any other additional info. Will be omitted in final JSON if null

public record ApiError(String message, String details)
extends Record

DTO type that is used to populate @ResponseBody of @ExceptionHandler methods in ExceptionHandlingAdvice.

Since:

1.0

Author:

Ilya Nikolaev

Constructor Summary

Constructors

Constructor	Description
ApiError(String message, String details)	Creates an instance of a ApiError record class.

Method Summary

Modifier and Type	Method	Description
String	details()	Returns the value of the details 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.
String	message()	Returns the value of the message 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

ApiError

public ApiError(String message,
 String details)

Creates an instance of a ApiError record class.

Parameters:

message - the value for the message record component

details - the value for the details 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.

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

details

public String details()

Returns the value of the details record component.

Returns:

the value of the details record component