Module utility.exception.mapper

Package uk.co.jasonmarston.kiunzi.utility.exception.mapper.response

Record Class ValidationErrorResponse

java.lang.Object

java.lang.Record

uk.co.jasonmarston.kiunzi.utility.exception.mapper.response.ValidationErrorResponse

Record Components:

title - the summary title of the validation failure

status - the HTTP status code associated with the response

violations - the individual field or property violations that caused the failure

public record ValidationErrorResponse(String title, int status, List<ValidationErrorResponse.Violation> violations)
extends Record

Error payload returned when one or more validation or invariant violations must be reported to the client.

See Also:

• DomainInvariantViolationExceptionMapper

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ValidationErrorResponse.Violation	Describes a single validation failure within a ValidationErrorResponse.

Constructor Summary

Constructors

Constructor	Description
ValidationErrorResponse(String title, int status, List<ValidationErrorResponse.Violation> violations)	Creates an instance of a ValidationErrorResponse record class.

Method Summary

Modifier and Type	Method	Description
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.
int	status()	Returns the value of the status record component.
String	title()	Returns the value of the title record component.
final String	toString()	Returns a string representation of this record class.
List<ValidationErrorResponse.Violation>	violations()	Returns the value of the violations record component.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ValidationErrorResponse

public ValidationErrorResponse(String title,
 int status,
 List<ValidationErrorResponse.Violation> violations)

Creates an instance of a ValidationErrorResponse record class.

Parameters:

title - the value for the title record component

status - the value for the status record component

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

title

public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

status

public int status()

Returns the value of the status record component.

Returns:

the value of the status record component

violations

public List<ValidationErrorResponse.Violation> violations()

Returns the value of the violations record component.

Returns:

the value of the violations record component