org.springframework.validation
Class BindException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          org.springframework.validation.BindException

All Implemented Interfaces:

Serializable, Errors

public class BindException
extends Exception
implements Errors

Default implementation of the Errors interface, supporting registration and evaluation of binding errors. Slightly unusual, as it is an exception.

This is mainly a framework-internal class. Normally, application code will work with the Errors interface, or a DataBinder that in turn exposes a BindException via getErrors().

Supports exporting a model, suitable for example for web MVC. Thus, it is sometimes used as parameter type instead of the Errors interface itself - if extracting the model makes sense in the particular context.

Author:

Rod Johnson, Juergen Hoeller

See Also:

getModel(), DataBinder.getErrors(), Serialized Form

Field Summary

static String

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

Fields inherited from interface org.springframework.validation.Errors

NESTED_PATH_SEPARATOR

Constructor Summary

BindException(Object target, String objectName)
Create a new BindException instance.

Method Summary

void	addAllErrors(Errors errors) Add all errors from the given Errors instance to this Errors instance.
void	addError(ObjectError error) Add an ObjectError or FieldError to the errors list.
protected void	doSetNestedPath(String nestedPath) Actually set the nested path.
protected String	fixedField(String field) Transform the given field into its full path, regarding the nested path of this instance.
List	getAllErrors() Get all errors, both global and field ones.
protected BeanWrapper	getBeanWrapper() Return the BeanWrapper that this instance uses.
PropertyEditor	getCustomEditor(String field) Retrieve the custom PropertyEditor for the given field, if any.
int	getErrorCount() Return the total number of errors.
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.
List	getFieldErrors(String field) Get all errors associated with the 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.
MessageCodesResolver	getMessageCodesResolver() Return the strategy to use for resolving errors into message codes.
Map	getModel() Return a model Map for the obtained state, exposing an Errors instance as 'ERROR_KEY_PREFIX + objectName' and the object itself.
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 BeanWrapper as PropertyEditorRegistry.
Object	getTarget() Return the wrapped target object.
boolean	hasErrors() Return if there were any errors.
boolean	hasFieldErrors(String field) Are there any errors associated with the given field?
boolean	hasGlobalErrors() Are there any global errors?
protected boolean	isMatchingFieldError(String field, FieldError fieldError) Check whether the given FieldError matches the given field.
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	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) 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, 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.
void	setNestedPath(String nestedPath) Allow context to be changed so that standard validators can validate subtrees.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ERROR_KEY_PREFIX

public static final String ERROR_KEY_PREFIX

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

Constructor Detail

BindException

public BindException(Object target,
                     String objectName)

Create a new BindException instance.

Parameters:

target - target object to bind onto

objectName - the name of the target object

See Also:

DefaultMessageCodesResolver

Method Detail

getTarget

public Object getTarget()

Return the wrapped target object.

getObjectName

public String getObjectName()

Description copied from interface: Errors

Return the name of the bound root object.

Specified by:

getObjectName in interface Errors

getBeanWrapper

protected BeanWrapper getBeanWrapper()

Return the BeanWrapper that this instance uses. Creates a new one if none existed before.

getPropertyEditorRegistry

public PropertyEditorRegistry getPropertyEditorRegistry()

Return the underlying BeanWrapper as PropertyEditorRegistry.

See Also:

getBeanWrapper()

setMessageCodesResolver

public void setMessageCodesResolver(MessageCodesResolver messageCodesResolver)

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

See Also:

DefaultMessageCodesResolver

getMessageCodesResolver

public MessageCodesResolver getMessageCodesResolver()

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

setNestedPath

public void setNestedPath(String nestedPath)

Description copied from interface: Errors

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.

Specified by:

setNestedPath in interface Errors

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.

getNestedPath

public String getNestedPath()

Description copied from interface: Errors

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.

Specified by:

getNestedPath in interface Errors

pushNestedPath

public void pushNestedPath(String subPath)

Description copied from interface: Errors

Push the given sub path onto the nested path stack.

A Errors.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.

Specified by:

pushNestedPath in interface Errors

Parameters:

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

See Also:

Errors.popNestedPath()

popNestedPath

public void popNestedPath()
                   throws IllegalArgumentException

Description copied from interface: Errors

Pop the former nested path from the nested path stack.

Specified by:

popNestedPath in interface Errors

Throws:

IllegalArgumentException

See Also:

Errors.pushNestedPath(java.lang.String)

doSetNestedPath

protected void doSetNestedPath(String nestedPath)

Actually set the nested path. Delegated to by setNestedPath and pushNestedPath.

fixedField

protected String fixedField(String field)

Transform the given field into its full path, regarding the nested path of this instance.

reject

public void reject(String errorCode)

Description copied from interface: Errors

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

Specified by:

reject in interface Errors

Parameters:

errorCode - error code, interpretable as a message key

reject

public void reject(String errorCode,
                   String defaultMessage)

Description copied from interface: Errors

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

Specified by:

reject in interface Errors

Parameters:

errorCode - error code, interpretable as a message key

defaultMessage - fallback default message

reject

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

Description copied from interface: Errors

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

Specified by:

reject in interface Errors

Parameters:

errorCode - error code, interpretable as a message key

errorArgs - error arguments, for argument binding via MessageFormat (can be null)

defaultMessage - fallback default message

rejectValue

public void rejectValue(String field,
                        String errorCode)

Description copied from interface: Errors

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.

Specified by:

rejectValue in interface Errors

Parameters:

field - the field name (may be null or empty String)

errorCode - error code, interpretable as a message key

See Also:

Errors.getNestedPath()

rejectValue

public void rejectValue(String field,
                        String errorCode,
                        String defaultMessage)

Description copied from interface: Errors

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.

Specified by:

rejectValue in interface Errors

Parameters:

field - the field name (may be null or empty String)

errorCode - error code, interpretable as a message key

defaultMessage - fallback default message

See Also:

Errors.getNestedPath()

rejectValue

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

Description copied from interface: Errors

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.

Specified by:

rejectValue in interface Errors

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

See Also:

Errors.getNestedPath()

resolveMessageCodes

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:

setMessageCodesResolver(org.springframework.validation.MessageCodesResolver)

resolveMessageCodes

public 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

See Also:

setMessageCodesResolver(org.springframework.validation.MessageCodesResolver)

addError

public 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

addAllErrors

public void addAllErrors(Errors errors)

Description copied from interface: 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.

Specified by:

addAllErrors in interface Errors

Parameters:

errors - the Errors instance to merge in

hasErrors

public boolean hasErrors()

Description copied from interface: Errors

Return if there were any errors.

Specified by:

hasErrors in interface Errors

getErrorCount

public int getErrorCount()

Description copied from interface: Errors

Return the total number of errors.

Specified by:

getErrorCount in interface Errors

getAllErrors

public List getAllErrors()

Description copied from interface: Errors

Get all errors, both global and field ones.

Specified by:

getAllErrors in interface Errors

Returns:

List of ObjectError instances

hasGlobalErrors

public boolean hasGlobalErrors()

Description copied from interface: Errors

Are there any global errors?

Specified by:

hasGlobalErrors in interface Errors

Returns:

true if there are any global errors

getGlobalErrorCount

public int getGlobalErrorCount()

Description copied from interface: Errors

Return the number of global errors.

Specified by:

getGlobalErrorCount in interface Errors

Returns:

the number of global errors

getGlobalErrors

public List getGlobalErrors()

Description copied from interface: Errors

Get all global errors.

Specified by:

getGlobalErrors in interface Errors

Returns:

List of ObjectError instances

getGlobalError

public ObjectError getGlobalError()

Description copied from interface: Errors

Get the first global error, if any.

Specified by:

getGlobalError in interface Errors

Returns:

the global error, or null

hasFieldErrors

public boolean hasFieldErrors(String field)

Description copied from interface: Errors

Are there any errors associated with the given field?

Specified by:

hasFieldErrors in interface Errors

Parameters:

field - the field name

Returns:

true if there were any errors associated with the given field

getFieldErrorCount

public int getFieldErrorCount(String field)

Description copied from interface: Errors

Return the number of errors associated with the given field.

Specified by:

getFieldErrorCount in interface Errors

Parameters:

field - the field name

Returns:

the number of errors associated with the given field

getFieldErrors

public List getFieldErrors(String field)

Description copied from interface: Errors

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.*".

Specified by:

getFieldErrors in interface Errors

Parameters:

field - the field name

Returns:

a List of FieldError instances

getFieldError

public FieldError getFieldError(String field)

Description copied from interface: Errors

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

Specified by:

getFieldError in interface Errors

Parameters:

field - the field name

Returns:

the field-specific error, or null

isMatchingFieldError

protected boolean isMatchingFieldError(String field,
                                       FieldError fieldError)

Check whether the given FieldError matches the given field.

Parameters:

field - the field that we are looking up FieldErrors for

fieldError - the candidate FieldError

Returns:

whether the FieldError matches the given field

getFieldValue

public Object getFieldValue(String field)

Description copied from interface: Errors

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.

Specified by:

getFieldValue in interface Errors

Parameters:

field - the field name

Returns:

the current value of the given field

getCustomEditor

public PropertyEditor getCustomEditor(String field)

Retrieve the custom PropertyEditor for the given field, if any.

Parameters:

field - the field name

Returns:

the custom PropertyEditor, or null

getModel

public Map getModel()

Return a model Map for the obtained state, exposing an Errors instance as 'ERROR_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:

getObjectName(), ERROR_KEY_PREFIX, ModelAndView, BindTag, SimpleFormController

getMessage

public String getMessage()

Returns diagnostic information about the errors held in this object.

Overrides:

getMessage in class Throwable