public abstract class

AbstractBindingResult

extends AbstractErrors
implements Serializable BindingResult
java.lang.Object
   ↳ org.springframework.validation.AbstractErrors
     ↳ org.springframework.validation.AbstractBindingResult
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Abstract implementation of the BindingResult interface and its super-interface Errors. Encapsulates common management of ObjectErrors and FieldErrors.

See Also

Summary

[Expand]
Inherited Constants
From interface org.springframework.validation.Errors
[Expand]
Inherited Fields
From interface org.springframework.validation.BindingResult
Protected Constructors
AbstractBindingResult(String objectName)
Create a new AbstractBindingResult instance.
Public Methods
void addAllErrors(Errors errors)
Add all errors from the given Errors instance to this Errors instance.
void addError(ObjectError error)
Add a custom ObjectError or FieldError to the errors list.
boolean equals(Object other)
PropertyEditor findEditor(String field, Class valueType)
This implementation delegates to the PropertyEditorRegistry's editor lookup facility, if available.
List<ObjectError> getAllErrors()
Get all errors, both global and field ones.
int getErrorCount()
Return the total number of errors.
FieldError getFieldError()
Get the first error associated with a field, if any.
FieldError getFieldError(String field)
Get the first error associated with the given field, if any.
List<FieldError> getFieldErrors()
Get all errors associated with a field.
List<FieldError> getFieldErrors(String field)
Get all errors associated with the given field.
Class getFieldType(String field)
This default implementation determines the type based on the actual field value, if any.
Object getFieldValue(String field)
Return the current value of the given field, either the current bean property value or a rejected update from the last binding.
ObjectError getGlobalError()
Get the first global error, if any.
List<ObjectError> getGlobalErrors()
Get all global errors.
MessageCodesResolver getMessageCodesResolver()
Return the strategy to use for resolving errors into message codes.
Map<String, Object> getModel()
Return a model Map for the obtained state, exposing an Errors instance as 'MODEL_KEY_PREFIX + objectName' and the object itself.
String getObjectName()
Return the name of the bound root object.
PropertyEditorRegistry getPropertyEditorRegistry()
This implementation returns null.
Object getRawFieldValue(String field)
Extract the raw field value for the given field.
String[] getSuppressedFields()
Return the list of fields that were suppressed during the bind process.
abstract Object getTarget()
Return the wrapped target object.
boolean hasErrors()
Return if there were any errors.
int hashCode()
void recordSuppressedField(String field)
Mark the specified disallowed field as suppressed.
void reject(String errorCode, Object[] errorArgs, String defaultMessage)
Register a global error for the entire target object, using the given error description.
void rejectValue(String field, String errorCode, Object[] errorArgs, String defaultMessage)
Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.
String[] resolveMessageCodes(String errorCode)
Resolve the given error code into message codes.
String[] resolveMessageCodes(String errorCode, String field)
Resolve the given error code into message codes for the given field.
void setMessageCodesResolver(MessageCodesResolver messageCodesResolver)
Set the strategy to use for resolving errors into message codes.
Protected Methods
Object formatFieldValue(String field, Object value)
Format the given value for the specified field.
abstract Object getActualFieldValue(String field)
Extract the actual field value for the given field.
[Expand]
Inherited Methods
From class org.springframework.validation.AbstractErrors
From class java.lang.Object
From interface org.springframework.validation.BindingResult
From interface org.springframework.validation.Errors

Protected Constructors

protected AbstractBindingResult (String objectName)

Create a new AbstractBindingResult instance.

Parameters
objectName the name of the target object
See Also

Public Methods

public void addAllErrors (Errors errors)

Add all errors from the given Errors instance to this Errors instance.

This is a onvenience method to avoid repeated reject(..) calls for merging an Errors instance into another Errors instance.

Note that the passed-in Errors instance is supposed to refer to the same target object, or at least contain compatible errors that apply to the target object of this Errors instance.

Parameters
errors the Errors instance to merge in

public void addError (ObjectError error)

Add a custom ObjectError or FieldError to the errors list.

Intended to be used by cooperating strategies such as BindingErrorProcessor.

public boolean equals (Object other)

public PropertyEditor findEditor (String field, Class valueType)

This implementation delegates to the PropertyEditorRegistry's editor lookup facility, if available.

Parameters
field the path of the property (name or nested path), or null if looking for an editor for all properties of the given type
valueType the type of the property (can be null if a property is given but should be specified in any case for consistency checking)
Returns
  • the registered editor, or null if none

public List<ObjectError> getAllErrors ()

Get all errors, both global and field ones.

Returns

public int getErrorCount ()

Return the total number of errors.

public FieldError getFieldError ()

Get the first error associated with a field, if any.

Returns
  • the field-specific error, or null

public FieldError getFieldError (String field)

Get the first error associated with the given field, if any.

Parameters
field the field name
Returns
  • the field-specific error, or null

public List<FieldError> getFieldErrors ()

Get all errors associated with a field.

Returns

public List<FieldError> getFieldErrors (String field)

Get all errors associated with the given field.

Implementations should support not only full field names like "name" but also pattern matches like "na*" or "address.*".

Parameters
field the field name
Returns

public Class getFieldType (String field)

This default implementation determines the type based on the actual field value, if any. Subclasses should override this to determine the type from a descriptor, even for null values.

Parameters
field the field name
Returns
  • the type of the field, or null if not determinable
See Also

public Object getFieldValue (String field)

Return the current value of the given field, either the current bean property value or a rejected update from the last binding.

Allows for convenient access to user-specified field values, even if there were type mismatches.

Parameters
field the field name
Returns
  • the current value of the given field

public ObjectError getGlobalError ()

Get the first global error, if any.

Returns
  • the global error, or null

public List<ObjectError> getGlobalErrors ()

Get all global errors.

Returns
  • List of ObjectError instances

public MessageCodesResolver getMessageCodesResolver ()

Return the strategy to use for resolving errors into message codes.

public Map<String, Object> getModel ()

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

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 Errors instance. Spring's SimpleFormController will do this for you when rendering its form or success view. When building the ModelAndView yourself, you need to include the attributes from the model Map returned by this method yourself.

See Also

public String getObjectName ()

Return the name of the bound root object.

public PropertyEditorRegistry getPropertyEditorRegistry ()

This implementation returns null.

Returns
  • the PropertyEditorRegistry, or null if none available for this BindingResult

public Object getRawFieldValue (String field)

Extract the raw field value for the given field. Typically used for comparison purposes.

Parameters
field the field to check
Returns
  • the current value of the field in its raw form, or null if not known

public 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

public abstract Object getTarget ()

Return the wrapped target object.

public boolean hasErrors ()

Return if there were any errors.

public int hashCode ()

public void recordSuppressedField (String field)

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

public void reject (String errorCode, Object[] errorArgs, String defaultMessage)

Register a global error for the entire target object, using the given error description.

Parameters
errorCode error code, interpretable as a message key
errorArgs error arguments, for argument binding via MessageFormat (can be null)
defaultMessage fallback default message

public void rejectValue (String field, String errorCode, Object[] errorArgs, String defaultMessage)

Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.

The field name may be null or empty String to indicate the current object itself rather than a field of it. This may result in a corresponding field error within the nested object graph or a global error if the current object is the top object.

Parameters
field the field name (may be null or empty String)
errorCode error code, interpretable as a message key
errorArgs error arguments, for argument binding via MessageFormat (can be null)
defaultMessage fallback default message

public String[] resolveMessageCodes (String errorCode)

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

Parameters
errorCode the error code to resolve into message codes
Returns
  • the resolved message codes
See Also

public String[] resolveMessageCodes (String errorCode, String field)

Resolve the given error code into message codes for the given field.

Calls the configured 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

public void setMessageCodesResolver (MessageCodesResolver messageCodesResolver)

Set the strategy to use for resolving errors into message codes. Default is DefaultMessageCodesResolver.

See Also

Protected Methods

protected Object formatFieldValue (String field, Object value)

Format the given value for the specified field.

The default implementation simply returns the field value as-is.

Parameters
field the field to check
value the value of the field (either a rejected value other than from a binding error, or an actual field value)
Returns
  • the formatted value

protected abstract Object getActualFieldValue (String field)

Extract the actual field value for the given field.

Parameters
field the field to check
Returns
  • the current value of the field