org.springframework.validation
Interface BindingResult

All Superinterfaces:

Errors

All Known Implementing Classes:

AbstractBindingResult, AbstractPropertyBindingResult, BeanPropertyBindingResult, BindException, DirectFieldBindingResult, MapBindingResult

public interface BindingResult
extends Errors

General interface that represents binding results. Extends the Errors interface for error registration capabilities and adds binding-specific functionality.

Serves as result holder for DataBinder. Implementations can also be used directly, for example to invoke a Validator on it.

Since:

2.0

Author:

Juergen Hoeller

See Also:

DataBinder.getBindingResult(), Errors, Validator, BeanPropertyBindingResult, MapBindingResult

Field Summary

static String

MODEL_KEY_PREFIX Prefix for the name of the BindingResult instance in a model, followed by the object name.

Fields inherited from interface org.springframework.validation.Errors

NESTED_PATH_SEPARATOR

Method Summary

void	addError(ObjectError error) Add an ObjectError or FieldError to the errors list.
Map	getModel() Return a model Map for the obtained state, exposing a BindingResult instance as 'MODEL_KEY_PREFIX + objectName' and the object itself as 'objectName'.
PropertyEditorRegistry	getPropertyEditorRegistry() Return the underlying PropertyEditorRegistry.
String[]	getSuppressedFields() Return the list of fields that were suppressed during the bind process.
Object	getTarget() Return the wrapped target object.
void	recordSuppressedField(String fieldName) Mark the specified disallowed field as suppressed.
String[]	resolveMessageCodes(String errorCode, String field) Resolve the given error code into message codes for the given field.

Methods inherited from interface org.springframework.validation.Errors

addAllErrors, getAllErrors, getErrorCount, getFieldError, getFieldError, getFieldErrorCount, getFieldErrorCount, getFieldErrors, getFieldErrors, getFieldType, getFieldValue, getGlobalError, getGlobalErrorCount, getGlobalErrors, getNestedPath, getObjectName, hasErrors, hasFieldErrors, hasFieldErrors, hasGlobalErrors, popNestedPath, pushNestedPath, reject, reject, reject, rejectValue, rejectValue, rejectValue, setNestedPath

Field Detail

MODEL_KEY_PREFIX

static final String MODEL_KEY_PREFIX

Prefix for the name of the BindingResult instance in a model, followed by the object name.

Method Detail

getTarget

Object getTarget()

Return the wrapped target object.

getModel

Map getModel()

Return a model Map for the obtained state, exposing a BindingResult instance as 'MODEL_KEY_PREFIX + objectName' and the object itself as 'objectName'.

Note that the Map is constructed every time you're calling this method. Adding things to the map and then re-calling this method will not work.

The attributes in the model Map returned by this method are usually included in the ModelAndView for a form view that uses Spring's bind tag, which needs access to the BindingResult instance. Spring's pre-built form controllers will do this for you when rendering a form view. When building the ModelAndView yourself, you need to include the attributes from the model Map returned by this method yourself.

See Also:

Errors.getObjectName(), MODEL_KEY_PREFIX, ModelAndView, BindTag, SimpleFormController

getPropertyEditorRegistry

PropertyEditorRegistry getPropertyEditorRegistry()

Return the underlying PropertyEditorRegistry.

Throws:

UnsupportedOperationException - if the BindingResult does not support a PropertyEditorRegistry

recordSuppressedField

void recordSuppressedField(String fieldName)

Mark the specified disallowed field as suppressed.

The data binder invokes this for each field value that was detected to target a disallowed field.

See Also:

DataBinder.setAllowedFields(java.lang.String[])

getSuppressedFields

String[] getSuppressedFields()

Return the list of fields that were suppressed during the bind process.

Can be used to determine whether any field values were targetting disallowed fields.

See Also:

DataBinder.setAllowedFields(java.lang.String[])

addError

void addError(ObjectError error)

Add an ObjectError or FieldError to the errors list.

Intended to be used by subclasses like DataBinder, or by cooperating strategies like a BindingErrorProcessor.

See Also:

ObjectError, FieldError, DataBinder, BindingErrorProcessor

resolveMessageCodes

String[] resolveMessageCodes(String errorCode,
                             String field)

Resolve the given error code into message codes for the given field. Calls the MessageCodesResolver with appropriate parameters.

Parameters:

errorCode - the error code to resolve into message codes

field - the field to resolve message codes for

Returns:

the resolved message codes