Class BindException
- java.lang.Object
- java.lang.Throwable
- java.lang.Exception
- org.springframework.validation.BindException
- All Implemented Interfaces:
Serializable
,BindingResult
,Errors
public class BindException extends Exception implements BindingResult
Thrown when binding errors are considered fatal. Implements theBindingResult
interface (and its super-interfaceErrors
) 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 aDataBinder
that in turn exposes a BindingResult viaDataBinder.getBindingResult()
.- Author:
- Rod Johnson, Juergen Hoeller, Rob Harrop
- See Also:
BindingResult
,DataBinder.getBindingResult()
,DataBinder.close()
, Serialized Form
Field Summary
Fields inherited from interface org.springframework.validation.BindingResult
MODEL_KEY_PREFIX
Fields inherited from interface org.springframework.validation.Errors
NESTED_PATH_SEPARATOR
Constructor Summary
Constructors Constructor Description BindException(Object target, String objectName)
Create a new BindException instance for a target bean.BindException(BindingResult bindingResult)
Create a new BindException instance for a BindingResult.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAllErrors(Errors errors)
Add all errors from the givenErrors
instance to thisErrors
instance.void
addError(ObjectError error)
Add a customObjectError
orFieldError
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<ObjectError>
getAllErrors()
Get all errors, both global and field ones.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()
Return the number of errors associated with a field.int
getFieldErrorCount(String field)
Return the number of errors associated with the given field.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)
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<ObjectError>
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 thisErrors
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()
Are there any field errors?boolean
hasFieldErrors(String field)
Are there any errors associated with the given field?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)
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
setNestedPath(String nestedPath)
Allow context to be changed so that standard validators can validate subtrees.Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
Constructor Detail
BindException
public BindException(BindingResult bindingResult)
Create a new BindException instance for a BindingResult.- Parameters:
bindingResult
- the BindingResult instance to wrap
BindException
public BindException(Object target, String objectName)
Create a new BindException instance for a target bean.- Parameters:
target
- target bean to bind ontoobjectName
- the name of the target object- See Also:
BeanPropertyBindingResult
Method Detail
getBindingResult
public final BindingResult getBindingResult()
Return the BindingResult that this BindException wraps. Will typically be a BeanPropertyBindingResult.- See Also:
BeanPropertyBindingResult
getObjectName
public String getObjectName()
Description copied from interface:Errors
Return the name of the bound root object.- Specified by:
getObjectName
in interfaceErrors
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 interfaceErrors
- 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 thisErrors
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 interfaceErrors
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 correspondingpushNestedPath(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 interfaceErrors
- Parameters:
subPath
- the sub path to push onto the nested path stack- See Also:
Errors.popNestedPath()
popNestedPath
public void popNestedPath() throws IllegalStateException
Description copied from interface:Errors
Pop the former nested path from the nested path stack.- Specified by:
popNestedPath
in interfaceErrors
- Throws:
IllegalStateException
- if there is no former nested path on the stack- See Also:
Errors.pushNestedPath(java.lang.String)
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.
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.
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.
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 interfaceErrors
- Parameters:
field
- the field name (may benull
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 interfaceErrors
- Parameters:
field
- the field name (may benull
or empty String)errorCode
- error code, interpretable as a message keydefaultMessage
- 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 interfaceErrors
- Parameters:
field
- the field name (may benull
or empty String)errorCode
- error code, interpretable as a message keyerrorArgs
- error arguments, for argument binding via MessageFormat (can benull
)defaultMessage
- fallback default message- See Also:
Errors.getNestedPath()
addAllErrors
public void addAllErrors(Errors errors)
Description copied from interface:Errors
Add all errors from the givenErrors
instance to thisErrors
instance.This is a convenience method to avoid repeated
reject(..)
calls for merging anErrors
instance into anotherErrors
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 thisErrors
instance.- Specified by:
addAllErrors
in interfaceErrors
- Parameters:
errors
- theErrors
instance to merge in
hasErrors
public boolean hasErrors()
Description copied from interface:Errors
Return if there were any errors.
getErrorCount
public int getErrorCount()
Description copied from interface:Errors
Return the total number of errors.- Specified by:
getErrorCount
in interfaceErrors
getAllErrors
public List<ObjectError> getAllErrors()
Description copied from interface:Errors
Get all errors, both global and field ones.- Specified by:
getAllErrors
in interfaceErrors
- Returns:
- List of
ObjectError
instances
hasGlobalErrors
public boolean hasGlobalErrors()
Description copied from interface:Errors
Are there any global errors?- Specified by:
hasGlobalErrors
in interfaceErrors
- Returns:
true
if there are any global errors- See Also:
Errors.hasFieldErrors()
getGlobalErrorCount
public int getGlobalErrorCount()
Description copied from interface:Errors
Return the number of global errors.- Specified by:
getGlobalErrorCount
in interfaceErrors
- Returns:
- the number of global errors
- See Also:
Errors.getFieldErrorCount()
getGlobalErrors
public List<ObjectError> getGlobalErrors()
Description copied from interface:Errors
Get all global errors.- Specified by:
getGlobalErrors
in interfaceErrors
- 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 interfaceErrors
- Returns:
- the global error, or
null
hasFieldErrors
public boolean hasFieldErrors()
Description copied from interface:Errors
Are there any field errors?- Specified by:
hasFieldErrors
in interfaceErrors
- Returns:
true
if there are any errors associated with a field- See Also:
Errors.hasGlobalErrors()
getFieldErrorCount
public int getFieldErrorCount()
Description copied from interface:Errors
Return the number of errors associated with a field.- Specified by:
getFieldErrorCount
in interfaceErrors
- Returns:
- the number of errors associated with a field
- See Also:
Errors.getGlobalErrorCount()
getFieldErrors
public List<FieldError> getFieldErrors()
Description copied from interface:Errors
Get all errors associated with a field.- Specified by:
getFieldErrors
in interfaceErrors
- Returns:
- a List of
FieldError
instances
getFieldError
public FieldError getFieldError()
Description copied from interface:Errors
Get the first error associated with a field, if any.- Specified by:
getFieldError
in interfaceErrors
- Returns:
- the field-specific 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 interfaceErrors
- 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 interfaceErrors
- Parameters:
field
- the field name- Returns:
- the number of errors associated with the given field
getFieldErrors
public List<FieldError> 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 interfaceErrors
- 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 interfaceErrors
- Parameters:
field
- the field name- Returns:
- the field-specific error, or
null
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 interfaceErrors
- Parameters:
field
- the field name- Returns:
- the current value of the given field
getFieldType
public Class<?> getFieldType(String field)
Description copied from interface:Errors
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.- Specified by:
getFieldType
in interfaceErrors
- Parameters:
field
- the field name- Returns:
- the type of the field, or
null
if not determinable
getTarget
public Object getTarget()
Description copied from interface:BindingResult
Return the wrapped target object, which may be a bean, an object with public fields, a Map - depending on the concrete binding strategy.- Specified by:
getTarget
in interfaceBindingResult
getModel
public Map<String,Object> getModel()
Description copied from interface:BindingResult
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'sbind
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.- Specified by:
getModel
in interfaceBindingResult
- See Also:
Errors.getObjectName()
,BindingResult.MODEL_KEY_PREFIX
,ModelAndView
,BindTag
getRawFieldValue
public Object getRawFieldValue(String field)
Description copied from interface:BindingResult
Extract the raw field value for the given field. Typically used for comparison purposes.- Specified by:
getRawFieldValue
in interfaceBindingResult
- Parameters:
field
- the field to check- Returns:
- the current value of the field in its raw form, or
null
if not known
findEditor
public PropertyEditor findEditor(String field, Class valueType)
Description copied from interface:BindingResult
Find a custom property editor for the given type and property.- Specified by:
findEditor
in interfaceBindingResult
- Parameters:
field
- the path of the property (name or nested path), ornull
if looking for an editor for all properties of the given typevalueType
- the type of the property (can benull
if a property is given but should be specified in any case for consistency checking)- Returns:
- the registered editor, or
null
if none
getPropertyEditorRegistry
public PropertyEditorRegistry getPropertyEditorRegistry()
Description copied from interface:BindingResult
Return the underlying PropertyEditorRegistry.- Specified by:
getPropertyEditorRegistry
in interfaceBindingResult
- Returns:
- the PropertyEditorRegistry, or
null
if none available for this BindingResult
addError
public void addError(ObjectError error)
Description copied from interface:BindingResult
Add a customObjectError
orFieldError
to the errors list.Intended to be used by cooperating strategies such as
BindingErrorProcessor
.- Specified by:
addError
in interfaceBindingResult
- See Also:
ObjectError
,FieldError
,BindingErrorProcessor
resolveMessageCodes
public String[] resolveMessageCodes(String errorCode)
Description copied from interface:BindingResult
Resolve the given error code into message codes.Calls the configured
MessageCodesResolver
with appropriate parameters.- Specified by:
resolveMessageCodes
in interfaceBindingResult
- Parameters:
errorCode
- the error code to resolve into message codes- Returns:
- the resolved message codes
resolveMessageCodes
public String[] resolveMessageCodes(String errorCode, String field)
Description copied from interface:BindingResult
Resolve the given error code into message codes for the given field.Calls the configured
MessageCodesResolver
with appropriate parameters.- Specified by:
resolveMessageCodes
in interfaceBindingResult
- Parameters:
errorCode
- the error code to resolve into message codesfield
- the field to resolve message codes for- Returns:
- the resolved message codes
recordSuppressedField
public void recordSuppressedField(String field)
Description copied from interface:BindingResult
Mark the specified disallowed field as suppressed.The data binder invokes this for each field value that was detected to target a disallowed field.
- Specified by:
recordSuppressedField
in interfaceBindingResult
- See Also:
DataBinder.setAllowedFields(java.lang.String...)
getSuppressedFields
public String[] getSuppressedFields()
Description copied from interface:BindingResult
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.
- Specified by:
getSuppressedFields
in interfaceBindingResult
- See Also:
DataBinder.setAllowedFields(java.lang.String...)
getMessage
public String getMessage()
Returns diagnostic information about the errors held in this object.- Overrides:
getMessage
in classThrowable