javax.mvc.binding

Interface BindingResult

public interface BindingResult

Describes the binding result of all controller fields and controller method parameters which are annotated with a binding annotation like FormParam.

A binding can fail because of type conversion issues or in case of validation errors. The former can for example happen if the binding annotation is placed on a numeric type but the value cannot be converted to that type. The latter may be caused by constraint violations detected during validation.

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

Since:

1.0

Author:

Christian Kaltepoth

Method Summary

Modifier and Type	Method and Description
Set<BindingError>	getAllBindingErrors() Returns an immutable set of all binding errors detected while processing parameter bindings.
List<String>	getAllMessages() Returns an immutable list of all messages representing both binding errors and constraint violations.
Set<javax.validation.ConstraintViolation<?>>	getAllViolations() Returns an immutable set of all constraint violations detected.
BindingError	getBindingError(String param) Returns the binding error for the binding specified by the given parameter name.
javax.validation.ConstraintViolation<?>	getViolation(String param) Returns a single constraint violation detected for a parameter binding specified by the given parameter name.
Set<javax.validation.ConstraintViolation<?>>	getViolations(String param) Returns an immutable set of all constraint violations detected for a parameter binding specified by the given parameter name.
boolean	isFailed() Returns true if there is at least one binding error or constraint violation.

Method Detail

isFailed

boolean isFailed()

Returns true if there is at least one binding error or constraint violation.

Returns:

true if there is at least one binding error constraint violation.

getAllMessages

List<String> getAllMessages()

Returns an immutable list of all messages representing both binding errors and constraint violations. The implementation will use BindingError.getMessage() and ConstraintViolation.getMessage() to create the individual messages.

Returns:

A list of human-readable messages

getAllBindingErrors

Set<BindingError> getAllBindingErrors()

Returns an immutable set of all binding errors detected while processing parameter bindings.

Returns:

All binding errors detected

getBindingError

BindingError getBindingError(String param)

Returns the binding error for the binding specified by the given parameter name. Will return null if no binding error was detected.

Parameters:

param - The parameter name

Returns:

The binding error or null

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 param)

Returns an immutable set of all constraint violations detected for a parameter binding specified by the given parameter name.

Parameters:

param - The parameter name

Returns:

All constraint violations for this parameter

See Also:

getViolation(String)

getViolation

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

Returns a single constraint violation detected for a parameter binding specified by the given parameter name. Will return the first if there is more than one violation null if no violation was detected.

Parameters:

param - The parameter name

Returns:

The first constraint violation for the parameter or null

See Also:

getViolation(String)