Package com.moeen.shared_lib.exception

Record Class ErrorResponse

java.lang.Object

java.lang.Record

com.moeen.shared_lib.exception.ErrorResponse

public record ErrorResponse(Instant timestamp, int status, String error, String message, String path, String traceId, Map<String,Object> details)
extends Record

Standardized error response body used across all microservices. Includes a trace ID for distributed tracing correlation and uses Instant for timezone-safe timestamps.

Constructor Summary

Constructors

Constructor	Description
ErrorResponse(Instant timestamp, int status, String error, String message, String path, String traceId, Map<String,Object> details)	Creates an instance of a ErrorResponse record class.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	details()	Returns the value of the details 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.
String	message()	Returns the value of the message record component.
static ErrorResponse	of(org.springframework.http.HttpStatusCode status, String error, String message, org.springframework.web.context.request.WebRequest request, @Nullable Map<String,Object> details)
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.
org.springframework.http.ResponseEntity<Object>	toResponseEntity()
org.springframework.http.ResponseEntity<Object>	toResponseEntity(org.springframework.http.HttpHeaders headers)
final String	toString()	Returns a string representation of this record class.
String	traceId()	Returns the value of the traceId record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ErrorResponse

public ErrorResponse(Instant timestamp,
 int status,
 String error,
 String message,
 String path,
 String traceId,
 Map<String,Object> details)

Creates an instance of a ErrorResponse 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

traceId - the value for the traceId record component

details - the value for the details record component

Method Details

of

public static ErrorResponse of(org.springframework.http.HttpStatusCode status,
 String error,
 String message,
 org.springframework.web.context.request.WebRequest request,
 @Nullable Map<String,Object> details)

toResponseEntity

public org.springframework.http.ResponseEntity<Object> toResponseEntity()

toResponseEntity

public org.springframework.http.ResponseEntity<Object> toResponseEntity(org.springframework.http.HttpHeaders headers)

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

traceId

public String traceId()

Returns the value of the traceId record component.

Returns:

the value of the traceId record component

details

public Map<String,Object> details()

Returns the value of the details record component.

Returns:

the value of the details record component