Package com.dani.bff.error

Record Class ApiError

java.lang.Object

java.lang.Record

com.dani.bff.error.ApiError

Record Components:

timestamp - time the error response was produced

status - numeric HTTP status

error - HTTP status reason phrase

message - stable, human-readable summary

path - request path that failed

public record ApiError(Instant timestamp, int status, String error, String message, String path)
extends Record

Structured error body returned by the BFF for predictable client-side handling.

Constructor Summary

Constructors

Constructor	Description
ApiError(Instant timestamp, int status, String error, String message, String path)	Creates an instance of a ApiError record class.

Method Summary

Modifier and Type	Method	Description
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.
String	message()	Returns the value of the message record component.
static ApiError	of(org.springframework.http.HttpStatus status, String message, String path)	Creates an API error with the current timestamp.
String	path()	Returns the value of the path record component.
int	status()	Returns the value of the status record component.
Instant	timestamp()	Returns the value of the timestamp 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(Instant timestamp,
 int status,
 String error,
 String message,
 String path)

Creates an instance of a ApiError record class.

Parameters:

timestamp - the value for the timestamp record component

status - the value for the status record component

error - the value for the error record component

message - the value for the message record component

path - the value for the path record component

Method Details

of

public static ApiError of(org.springframework.http.HttpStatus status,
 String message,
 String path)

Creates an API error with the current timestamp.

Parameters:

status - HTTP status to represent

message - stable message for clients and logs

path - request path

Returns:

structured API error

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.

timestamp

public Instant timestamp()

Returns the value of the timestamp record component.

Returns:

the value of the timestamp record component

status

public int status()

Returns the value of the status record component.

Returns:

the value of the status record component

error

public String error()

Returns the value of the error record component.

Returns:

the value of the error record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

path

public String path()

Returns the value of the path record component.

Returns:

the value of the path record component