javax.mvc.validation

Interface ValidationResult

All Superinterfaces:

Iterable<javax.validation.ConstraintViolation<?>>

public interface ValidationResult
extends Iterable<javax.validation.ConstraintViolation<?>>

Describes the validation result of all resource fields and resource method parameters which are annotated with Valid.

Controller methods which declare a parameter of this type will be executed even if the validation for fields and method parameters fails.

Since:

1.0

Author:

Christian Kaltepoth

Method Summary

Modifier and Type	Method and Description
Set<javax.validation.ConstraintViolation<?>>	getAllViolations() Returns an immutable set of all constraint violations detected.
javax.validation.ConstraintViolation<?>	getViolation(String propertyPath) Returns a single constraint violation detected for a property specified by the given property path.
int	getViolationCount() Returns the total number of constraint violations detected.
Set<javax.validation.ConstraintViolation<?>>	getViolations(String propertyPath) Returns an immutable set of all constraint violations detected for a property specified by the given property path.
boolean	isFailed() Returns true if there is at least one constraint violation.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

isFailed

boolean isFailed()

Returns true if there is at least one constraint violation. Same as checking whether getViolationCount() is greater than zero.

Returns:

true if there is at least one constraint violation.

getViolationCount

int getViolationCount()

Returns the total number of constraint violations detected. Same as calling getAllViolations().size().

Returns:

The number of constraint violations

getAllViolations

Set<javax.validation.ConstraintViolation<?>> getAllViolations()

Returns an immutable set of all constraint violations detected.

Returns:

All constraint violations detected

getViolations

Set<javax.validation.ConstraintViolation<?>> getViolations(String propertyPath)

Returns an immutable set of all constraint violations detected for a property specified by the given property path.

Parameters:

propertyPath - The property path (e.g. person.age)

Returns:

All constraint violations detected

See Also:

getViolation(String)

getViolation

javax.validation.ConstraintViolation<?> getViolation(String propertyPath)

Returns a single constraint violation detected for a property specified by the given property path. Will return the first violation if there are more than one detected and null if no violation was detected.

Parameters:

propertyPath - The property path (e.g. person.age)

Returns:

The first constraint violation or null if there are no violations.