public class

BindException

extends Exception
implements BindingResult
java.lang.Object
   ↳ java.lang.Throwable
     ↳ java.lang.Exception
       ↳ org.springframework.validation.BindException

Class Overview

Thrown when binding errors are considered fatal. Implements the BindingResult interface (and its super-interface Errors) to allow for the direct analysis of binding errors.

As of Spring 2.0, this is a special-purpose class. Normally, application code will work with the BindingResult interface, or with a DataBinder that in turn exposes a BindingResult via getBindingResult().

See Also

Summary

[Expand]
Inherited Constants
From interface org.springframework.validation.Errors
[Expand]
Inherited Fields
From interface org.springframework.validation.BindingResult
Public Constructors
BindException(BindingResult bindingResult)
Create a new BindException instance for a BindingResult.
BindException(Object target, String objectName)
Create a new BindException instance for a target bean.
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)
Find a custom property editor for the given type and property.
List getAllErrors()
Get all errors, both global and field ones.
final BindingResult getBindingResult()
Return the BindingResult that this BindException wraps.
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.
int getFieldErrorCount(String field)
Return the number of errors associated with the given field.
int getFieldErrorCount()
Return the number of errors associated with a field.
List getFieldErrors()
Get all errors associated with a field.
List getFieldErrors(String field)
Get all errors associated with the given field.
Class getFieldType(String field)
Return the type of a given field.
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.
int getGlobalErrorCount()
Return the number of global errors.
List getGlobalErrors()
Get all global errors.
String getMessage()
Returns diagnostic information about the errors held in this object.
Map<String, Object> getModel()
Return a model Map for the obtained state, exposing a BindingResult instance as 'MODEL_KEY_PREFIX + objectName' and the object itself as 'objectName'.
String getNestedPath()
Return the current nested path of this Errors object.
String getObjectName()
Return the name of the bound root object.
PropertyEditorRegistry getPropertyEditorRegistry()
Return the underlying PropertyEditorRegistry.
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.
Object getTarget()
Return the wrapped target object, which may be a bean, an object with public fields, a Map - depending on the concrete binding strategy.
boolean hasErrors()
Return if there were any errors.
boolean hasFieldErrors(String field)
Are there any errors associated with the given field?
boolean hasFieldErrors()
Are there any field errors?
boolean hasGlobalErrors()
Are there any global errors?
int hashCode()
void popNestedPath()
Pop the former nested path from the nested path stack.
void pushNestedPath(String subPath)
Push the given sub path onto the nested path stack.
void recordSuppressedField(String field)
Mark the specified disallowed field as suppressed.
void reject(String errorCode)
Register a global error for the entire target object, using the given error description.
void reject(String errorCode, Object[] errorArgs, String defaultMessage)
Register a global error for the entire target object, using the given error description.
void reject(String errorCode, String defaultMessage)
Register a global error for the entire target object, using the given error description.
void rejectValue(String field, String errorCode, 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.
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.
void rejectValue(String field, String errorCode)
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, String field)
Resolve the given error code into message codes for the given field.
void setNestedPath(String nestedPath)
Allow context to be changed so that standard validators can validate subtrees.
[Expand]
Inherited Methods
From class java.lang.Throwable
From class java.lang.Object
From interface org.springframework.validation.BindingResult
From interface org.springframework.validation.Errors

Public Constructors

public BindException (BindingResult bindingResult)

Create a new BindException instance for a BindingResult.

Parameters
bindingResult the BindingResult instance to wrap

public BindException (Object target, String objectName)

Create a new BindException instance for a target bean.

Parameters
target target bean to bind onto
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)

Find a custom property editor for the given type and property.

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 getAllErrors ()

Get all errors, both global and field ones.

Returns

public final BindingResult getBindingResult ()

Return the BindingResult that this BindException wraps. Will typically be a BeanPropertyBindingResult.

See Also

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 int getFieldErrorCount (String field)

Return the number of errors associated with the given field.

Parameters
field the field name
Returns
  • the number of errors associated with the given field

public int getFieldErrorCount ()

Return the number of errors associated with a field.

Returns
  • the number of errors associated with a field

public List getFieldErrors ()

Get all errors associated with a field.

Returns

public List 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)

Return the type of a given field.

Implementations should be able to determine the type even when the field value is null, for example from some associated descriptor.

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

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 int getGlobalErrorCount ()

Return the number of global errors.

Returns
  • the number of global errors

public List getGlobalErrors ()

Get all global errors.

Returns
  • List of ObjectError instances

public String getMessage ()

Returns diagnostic information about the errors held in this object.

public Map<String, Object> 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 in a JSP, 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 instance yourself, you need to include the attributes from the model Map returned by this method.

public String getNestedPath ()

Return the current nested path of this Errors object.

Returns a nested path with a dot, i.e. "address.", for easy building of concatenated paths. Default is an empty String.

public String getObjectName ()

Return the name of the bound root object.

public PropertyEditorRegistry getPropertyEditorRegistry ()

Return the underlying PropertyEditorRegistry.

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 targeting disallowed fields.

public Object getTarget ()

Return the wrapped target object, which may be a bean, an object with public fields, a Map - depending on the concrete binding strategy.

public boolean hasErrors ()

Return if there were any errors.

public boolean hasFieldErrors (String field)

Are there any errors associated with the given field?

Parameters
field the field name
Returns
  • true if there were any errors associated with the given field

public boolean hasFieldErrors ()

Are there any field errors?

Returns
  • true if there are any errors associated with a field

public boolean hasGlobalErrors ()

Are there any global errors?

Returns
  • true if there are any global errors

public int hashCode ()

public void popNestedPath ()

Pop the former nested path from the nested path stack.

Throws
IllegalStateException

public void pushNestedPath (String subPath)

Push the given sub path onto the nested path stack.

A popNestedPath() call will reset the original nested path before the corresponding pushNestedPath(String) call.

Using the nested path stack allows to set temporary nested paths for subobjects without having to worry about a temporary path holder.

For example: current path "spouse.", pushNestedPath("child") -> result path "spouse.child."; popNestedPath() -> "spouse." again.

Parameters
subPath the sub path to push onto the nested path stack

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.

public void reject (String errorCode)

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

Parameters
errorCode error code, interpretable as a message key

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 reject (String errorCode, 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
defaultMessage fallback default message

public void rejectValue (String field, String errorCode, 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
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 void rejectValue (String field, String errorCode)

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

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 setNestedPath (String nestedPath)

Allow context to be changed so that standard validators can validate subtrees. Reject calls prepend the given path to the field names.

For example, an address validator could validate the subobject "address" of a customer object.

Parameters
nestedPath nested path within this object, e.g. "address" (defaults to "", null is also acceptable). Can end with a dot: both "address" and "address." are valid.