Package org.springframework.validation.beanvalidation

Class MethodValidationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

jakarta.validation.ValidationException

jakarta.validation.ConstraintViolationException

org.springframework.validation.beanvalidation.MethodValidationException

All Implemented Interfaces:

Serializable, MethodValidationResult

public class MethodValidationException
extends ConstraintViolationException
implements MethodValidationResult

Extension of ConstraintViolationException that implements MethodValidationResult exposing an additional list of ParameterValidationResult that represents violations adapted to MessageSourceResolvable and grouped by method parameter.

Since:

6.1

Author:

Rossen Stoyanchev

See Also:

• ParameterValidationResult
• ParameterErrors
• MethodValidationAdapter
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MethodValidationException(Object target, Method method, Set<? extends ConstraintViolation<?>> violations, List<ParameterValidationResult> validationResults, boolean forReturnValue)

Method Summary

Modifier and Type	Method	Description
List<ParameterValidationResult>	getAllValidationResults()	Return all validation results.
List<ParameterErrors>	getBeanResults()	Return only validation results for @Valid method parameters with cascaded constraints.
Set<ConstraintViolation<?>>	getConstraintViolations()	Returns the set of constraint violations reported during a validation.
Method	getMethod()	Return the method to which validation was applied.
Object	getTarget()	Return the target of the method invocation to which validation was applied.
List<ParameterValidationResult>	getValueResults()	Return only validation results for method parameters with constraints declared directly on them.
boolean	isForReturnValue()	Whether the violations are for a return value.
void	throwIfViolationsPresent()	Check if MethodValidationResult.getConstraintViolations() is empty, and if not, raise MethodValidationException.
String	toString()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Details

MethodValidationException

public MethodValidationException(Object target,
 Method method,
 Set<? extends ConstraintViolation<?>> violations,
 List<ParameterValidationResult> validationResults,
 boolean forReturnValue)

Method Details

getTarget

public Object getTarget()

Return the target of the method invocation to which validation was applied.

getMethod

public Method getMethod()

Return the method to which validation was applied.

isForReturnValue

public boolean isForReturnValue()

Whether the violations are for a return value. If true the violations are from validating a return value. If false the violations are from validating method arguments.

getConstraintViolations

public Set<ConstraintViolation<?>> getConstraintViolations()

Description copied from interface: MethodValidationResult

Returns the set of constraint violations reported during a validation.

Specified by:

getConstraintViolations in interface MethodValidationResult

Overrides:

getConstraintViolations in class ConstraintViolationException

Returns:

the Set of ConstraintViolations, or an empty Set

getAllValidationResults

public List<ParameterValidationResult> getAllValidationResults()

Description copied from interface: MethodValidationResult

Return all validation results. This includes method parameters with constraints declared on them, as well as @Valid method parameters with cascaded constraints.

Specified by:

getAllValidationResults in interface MethodValidationResult

See Also:

• MethodValidationResult.getValueResults()
• MethodValidationResult.getBeanResults()

getValueResults

public List<ParameterValidationResult> getValueResults()

Description copied from interface: MethodValidationResult

Return only validation results for method parameters with constraints declared directly on them. This excludes @Valid method parameters with cascaded constraints.

Specified by:

getValueResults in interface MethodValidationResult

See Also:

• MethodValidationResult.getAllValidationResults()

getBeanResults

public List<ParameterErrors> getBeanResults()

Description copied from interface: MethodValidationResult

Return only validation results for @Valid method parameters with cascaded constraints. This excludes method parameters with constraints declared directly on them.

Specified by:

getBeanResults in interface MethodValidationResult

See Also:

• MethodValidationResult.getAllValidationResults()

throwIfViolationsPresent

public void throwIfViolationsPresent()

Description copied from interface: MethodValidationResult

Check if MethodValidationResult.getConstraintViolations() is empty, and if not, raise MethodValidationException.

Specified by:

throwIfViolationsPresent in interface MethodValidationResult

toString

public String toString()

Overrides:

toString in class Throwable