Package com.endurancetrio.business.common.dto

Record Class ErrorDTO

java.lang.Object

java.lang.Record

com.endurancetrio.business.common.dto.ErrorDTO

All Implemented Interfaces:

Serializable

public record ErrorDTO(int code, String error, String message)
extends Record
implements Serializable

The ErrorDTO class represents structured error information returned to API clients. It carries an HTTP status code, a machine-readable error key, and a human-readable message.

Constructor Usage

Generic Error (Enum Message)

Use when the enum's default message is sufficient:

   new ErrorDTO(EnduranceTrioError.NOT_FOUND)
 

Specific Error (Custom Message)

Use when providing request-specific context improves client error handling:

   new ErrorDTO(EnduranceTrioError.NOT_FOUND, "No route found with ID 42")
 

Field Semantics

• code: HTTP status code (e.g., 404). Aligns with response-level status but included for self-contained error objects in multi-error scenarios.
• error: Stable enum name (e.g., "NOT_FOUND"). Machine-readable; clients can switch/match on this for programmatic handling.
• message: Human-readable description. May be generic (from enum) or specific (from context). Intended for display or logging.

See Also:

• for predefined error types
• for exception usage patterns
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ErrorDTO(int code, String error, String message)	Creates an instance of a ErrorDTO record class.
ErrorDTO(EnduranceTrioError error)
ErrorDTO(EnduranceTrioError error, String message)

Method Summary

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

ErrorDTO

public ErrorDTO(EnduranceTrioError error)

ErrorDTO

public ErrorDTO(EnduranceTrioError error,
 String message)

ErrorDTO

public ErrorDTO(int code,
 String error,
 String message)

Creates an instance of a ErrorDTO record class.

Parameters:

code - the value for the code record component

error - the value for the error record component

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

code

public int code()

Returns the value of the code record component.

Returns:

the value of the code 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