Module io.avaje.http.api

Package io.avaje.http.api

Class ValidationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

io.avaje.http.api.ValidationException

All Implemented Interfaces:

Serializable

public class ValidationException
extends IllegalArgumentException

Exception used with Validator.

Typically this is used when validating a bean populated by request body content.

Generally this exception type is registered with an exception handler and configured to return a 422 or 400 http status response with the errors as a list of field error message.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ValidationException.Violation	Error details including the field, error message and path

Constructor Summary

Constructors

Constructor	Description
ValidationException(int status, String message)	Create with a status and message.
ValidationException(int status, String message, Throwable cause, List<ValidationException.Violation> errors)	Create with a status message and errors.
ValidationException(int status, String message, List<ValidationException.Violation> errors)	Create with a status message and errors.
ValidationException(String message)	Create with a message.

Method Summary

Modifier and Type	Method	Description
List<ValidationException.Violation>	getErrors()	Return the errors typically as a map of field to error message.
int	getStatus()	Return the suggested HTTP status to use in the response.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ValidationException

public ValidationException(String message)

Create with a message.

ValidationException

public ValidationException(int status,
 String message)

Create with a status and message.

ValidationException

public ValidationException(int status,
 String message,
 List<ValidationException.Violation> errors)

Create with a status message and errors.

ValidationException

public ValidationException(int status,
 String message,
 Throwable cause,
 List<ValidationException.Violation> errors)

Create with a status message and errors.

Method Details

getStatus

public int getStatus()

Return the suggested HTTP status to use in the response.

getErrors

public List<ValidationException.Violation> getErrors()

Return the errors typically as a map of field to error message.