public class BindException extends Exception implements BindingResult
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
DataBinder.getBindingResult().
BindingResult,
DataBinder.getBindingResult(),
DataBinder.close(),
Serialized FormMODEL_KEY_PREFIXNESTED_PATH_SEPARATOR| Constructor and Description |
|---|
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.
|
| Modifier and Type | Method and Description |
|---|---|
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<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 this
Errors object. |
String |
getObjectName()
Return the name of the bound root object.
|
org.springframework.beans.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 |
recordFieldValue(String field,
Class<?> type,
Object value)
Record the given value for the specified field.
|
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.
|
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringpublic BindException(BindingResult bindingResult)
bindingResult - the BindingResult instance to wrappublic BindException(Object target, String objectName)
target - target bean to bind ontoobjectName - the name of the target objectBeanPropertyBindingResultpublic final BindingResult getBindingResult()
BeanPropertyBindingResultpublic String getObjectName()
ErrorsgetObjectName in interface Errorspublic void setNestedPath(String nestedPath)
ErrorsFor example, an address validator could validate the subobject "address" of a customer object.
setNestedPath in interface ErrorsnestedPath - 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.public String getNestedPath()
ErrorsErrors object.
Returns a nested path with a dot, i.e. "address.", for easy building of concatenated paths. Default is an empty String.
getNestedPath in interface Errorspublic void pushNestedPath(String subPath)
ErrorsA 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.
pushNestedPath in interface ErrorssubPath - the sub path to push onto the nested path stackErrors.popNestedPath()public void popNestedPath()
throws IllegalStateException
ErrorspopNestedPath in interface ErrorsIllegalStateException - if there is no former nested path on the stackErrors.pushNestedPath(java.lang.String)public void reject(String errorCode)
Errorspublic void reject(String errorCode, String defaultMessage)
Errorspublic void reject(String errorCode, @Nullable Object[] errorArgs, @Nullable String defaultMessage)
Errorspublic void rejectValue(@Nullable
String field,
String errorCode)
ErrorsThe 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.
rejectValue in interface Errorsfield - the field name (may be null or empty String)errorCode - error code, interpretable as a message keyErrors.getNestedPath()public void rejectValue(@Nullable
String field,
String errorCode,
String defaultMessage)
ErrorsThe 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.
rejectValue in interface Errorsfield - the field name (may be null or empty String)errorCode - error code, interpretable as a message keydefaultMessage - fallback default messageErrors.getNestedPath()public void rejectValue(@Nullable
String field,
String errorCode,
@Nullable
Object[] errorArgs,
@Nullable
String defaultMessage)
ErrorsThe 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.
rejectValue in interface Errorsfield - the field name (may be null or empty String)errorCode - error code, interpretable as a message keyerrorArgs - error arguments, for argument binding via MessageFormat
(can be null)defaultMessage - fallback default messageErrors.getNestedPath()public void addAllErrors(Errors errors)
ErrorsErrors instance to this
Errors instance.
This is a convenience 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.
addAllErrors in interface Errorserrors - the Errors instance to merge inpublic boolean hasErrors()
Errorspublic int getErrorCount()
ErrorsgetErrorCount in interface Errorspublic List<ObjectError> getAllErrors()
ErrorsgetAllErrors in interface ErrorsObjectError instancespublic boolean hasGlobalErrors()
ErrorshasGlobalErrors in interface Errorstrue if there are any global errorsErrors.hasFieldErrors()public int getGlobalErrorCount()
ErrorsgetGlobalErrorCount in interface ErrorsErrors.getFieldErrorCount()public List<ObjectError> getGlobalErrors()
ErrorsgetGlobalErrors in interface ErrorsObjectError instances@Nullable public ObjectError getGlobalError()
ErrorsgetGlobalError in interface Errorsnullpublic boolean hasFieldErrors()
ErrorshasFieldErrors in interface Errorstrue if there are any errors associated with a fieldErrors.hasGlobalErrors()public int getFieldErrorCount()
ErrorsgetFieldErrorCount in interface ErrorsErrors.getGlobalErrorCount()public List<FieldError> getFieldErrors()
ErrorsgetFieldErrors in interface ErrorsFieldError instances@Nullable public FieldError getFieldError()
ErrorsgetFieldError in interface Errorsnullpublic boolean hasFieldErrors(String field)
ErrorshasFieldErrors in interface Errorsfield - the field nametrue if there were any errors associated with the given fieldpublic int getFieldErrorCount(String field)
ErrorsgetFieldErrorCount in interface Errorsfield - the field namepublic List<FieldError> getFieldErrors(String field)
ErrorsImplementations should support not only full field names like "name" but also pattern matches like "na*" or "address.*".
getFieldErrors in interface Errorsfield - the field nameFieldError instances@Nullable public FieldError getFieldError(String field)
ErrorsgetFieldError in interface Errorsfield - the field namenull@Nullable public Object getFieldValue(String field)
ErrorsAllows for convenient access to user-specified field values, even if there were type mismatches.
getFieldValue in interface Errorsfield - the field name@Nullable public Class<?> getFieldType(String field)
ErrorsImplementations should be able to determine the type even
when the field value is null, for example from some
associated descriptor.
getFieldType in interface Errorsfield - the field namenull if not determinablepublic Object getTarget()
BindingResultgetTarget in interface BindingResultpublic Map<String,Object> getModel()
BindingResultMODEL_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 org.springframework.web.servlet.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.
getModel in interface BindingResultErrors.getObjectName(),
BindingResult.MODEL_KEY_PREFIX,
org.springframework.web.servlet.ModelAndView,
org.springframework.web.servlet.tags.BindTag@Nullable public Object getRawFieldValue(String field)
BindingResultgetRawFieldValue in interface BindingResultfield - the field to checknull if not known@Nullable public PropertyEditor findEditor(@Nullable String field, @Nullable Class valueType)
BindingResultfindEditor in interface BindingResultfield - the path of the property (name or nested path), or
null if looking for an editor for all properties of the given typevalueType - the type of the property (can be null if a property
is given but should be specified in any case for consistency checking)null if none@Nullable public org.springframework.beans.PropertyEditorRegistry getPropertyEditorRegistry()
BindingResultgetPropertyEditorRegistry in interface BindingResultnull if none
available for this BindingResultpublic String[] resolveMessageCodes(String errorCode)
BindingResultCalls the configured MessageCodesResolver with appropriate parameters.
resolveMessageCodes in interface BindingResulterrorCode - the error code to resolve into message codespublic String[] resolveMessageCodes(String errorCode, String field)
BindingResultCalls the configured MessageCodesResolver with appropriate parameters.
resolveMessageCodes in interface BindingResulterrorCode - the error code to resolve into message codesfield - the field to resolve message codes forpublic void addError(ObjectError error)
BindingResultObjectError or FieldError to the errors list.
Intended to be used by cooperating strategies such as BindingErrorProcessor.
addError in interface BindingResultObjectError,
FieldError,
BindingErrorProcessorpublic void recordFieldValue(String field, Class<?> type, @Nullable Object value)
BindingResultTo be used when a target object cannot be constructed, making
the original field values available through Errors.getFieldValue(java.lang.String).
In case of a registered error, the rejected value will be exposed
for each affected field.
recordFieldValue in interface BindingResultfield - the field to record the value fortype - the type of the fieldvalue - the original valuepublic void recordSuppressedField(String field)
BindingResultThe data binder invokes this for each field value that was detected to target a disallowed field.
recordSuppressedField in interface BindingResultDataBinder.setAllowedFields(java.lang.String...)public String[] getSuppressedFields()
BindingResultCan be used to determine whether any field values were targeting disallowed fields.
getSuppressedFields in interface BindingResultDataBinder.setAllowedFields(java.lang.String...)public String getMessage()
getMessage in class Throwable