public abstract class AbstractBindingResult extends AbstractErrors implements BindingResult, java.io.Serializable
BindingResult interface and
its super-interface Errors. Encapsulates common management of
ObjectErrors and FieldErrors.Errors,
Serialized FormMODEL_KEY_PREFIXNESTED_PATH_SEPARATOR| Modifier | Constructor and Description |
|---|---|
protected |
AbstractBindingResult(java.lang.String objectName)
Create a new AbstractBindingResult instance.
|
| 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(java.lang.Object other) |
java.beans.PropertyEditor |
findEditor(java.lang.String field,
java.lang.Class<?> valueType)
This implementation delegates to the
PropertyEditorRegistry's
editor lookup facility, if available. |
protected java.lang.Object |
formatFieldValue(java.lang.String field,
java.lang.Object value)
Format the given value for the specified field.
|
protected abstract java.lang.Object |
getActualFieldValue(java.lang.String field)
Extract the actual field value for the given field.
|
java.util.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(java.lang.String field)
Get the first error associated with the given field, if any.
|
java.util.List<FieldError> |
getFieldErrors()
Get all errors associated with a field.
|
java.util.List<FieldError> |
getFieldErrors(java.lang.String field)
Get all errors associated with the given field.
|
java.lang.Class<?> |
getFieldType(java.lang.String field)
This default implementation determines the type based on the actual
field value, if any.
|
java.lang.Object |
getFieldValue(java.lang.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.
|
java.util.List<ObjectError> |
getGlobalErrors()
Get all global errors.
|
MessageCodesResolver |
getMessageCodesResolver()
Return the strategy to use for resolving errors into message codes.
|
java.util.Map<java.lang.String,java.lang.Object> |
getModel()
Return a model Map for the obtained state, exposing an Errors
instance as '
MODEL_KEY_PREFIX + objectName'
and the object itself. |
java.lang.String |
getObjectName()
Return the name of the bound root object.
|
org.springframework.beans.PropertyEditorRegistry |
getPropertyEditorRegistry()
This implementation returns
null. |
java.lang.Object |
getRawFieldValue(java.lang.String field)
Extract the raw field value for the given field.
|
java.lang.String[] |
getSuppressedFields()
Return the list of fields that were suppressed during the bind process.
|
abstract java.lang.Object |
getTarget()
Return the wrapped target object.
|
boolean |
hasErrors()
Return if there were any errors.
|
int |
hashCode() |
void |
recordSuppressedField(java.lang.String field)
Mark the specified disallowed field as suppressed.
|
void |
reject(java.lang.String errorCode,
java.lang.Object[] errorArgs,
java.lang.String defaultMessage)
Register a global error for the entire target object,
using the given error description.
|
void |
rejectValue(java.lang.String field,
java.lang.String errorCode,
java.lang.Object[] errorArgs,
java.lang.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.
|
java.lang.String[] |
resolveMessageCodes(java.lang.String errorCode)
Resolve the given error code into message codes.
|
java.lang.String[] |
resolveMessageCodes(java.lang.String errorCode,
java.lang.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.
|
canonicalFieldName, doSetNestedPath, fixedField, getFieldErrorCount, getFieldErrorCount, getGlobalErrorCount, getNestedPath, hasFieldErrors, hasFieldErrors, hasGlobalErrors, isMatchingFieldError, popNestedPath, pushNestedPath, reject, reject, rejectValue, rejectValue, setNestedPath, toStringclone, finalize, getClass, notify, notifyAll, wait, wait, waitgetFieldErrorCount, getFieldErrorCount, getGlobalErrorCount, getNestedPath, hasFieldErrors, hasFieldErrors, hasGlobalErrors, popNestedPath, pushNestedPath, reject, reject, rejectValue, rejectValue, setNestedPathprotected AbstractBindingResult(java.lang.String objectName)
objectName - the name of the target objectDefaultMessageCodesResolverpublic void setMessageCodesResolver(MessageCodesResolver messageCodesResolver)
DefaultMessageCodesResolverpublic MessageCodesResolver getMessageCodesResolver()
public java.lang.String getObjectName()
ErrorsgetObjectName in interface Errorspublic void reject(java.lang.String errorCode,
java.lang.Object[] errorArgs,
java.lang.String defaultMessage)
Errorspublic void rejectValue(java.lang.String field,
java.lang.String errorCode,
java.lang.Object[] errorArgs,
java.lang.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 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 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 java.lang.String[] resolveMessageCodes(java.lang.String errorCode)
BindingResultCalls the configured MessageCodesResolver with appropriate parameters.
resolveMessageCodes in interface BindingResulterrorCode - the error code to resolve into message codespublic java.lang.String[] resolveMessageCodes(java.lang.String errorCode,
java.lang.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 boolean hasErrors()
ErrorshasErrors in interface ErrorshasErrors in class AbstractErrorspublic int getErrorCount()
ErrorsgetErrorCount in interface ErrorsgetErrorCount in class AbstractErrorspublic java.util.List<ObjectError> getAllErrors()
ErrorsgetAllErrors in interface ErrorsgetAllErrors in class AbstractErrorsObjectError instancespublic java.util.List<ObjectError> getGlobalErrors()
ErrorsgetGlobalErrors in interface Errorspublic ObjectError getGlobalError()
ErrorsgetGlobalError in interface ErrorsgetGlobalError in class AbstractErrorsnullpublic java.util.List<FieldError> getFieldErrors()
ErrorsgetFieldErrors in interface ErrorsFieldError instancespublic FieldError getFieldError()
ErrorsgetFieldError in interface ErrorsgetFieldError in class AbstractErrorsnullpublic java.util.List<FieldError> getFieldErrors(java.lang.String field)
ErrorsImplementations should support not only full field names like "name" but also pattern matches like "na*" or "address.*".
getFieldErrors in interface ErrorsgetFieldErrors in class AbstractErrorsfield - the field nameFieldError instancespublic FieldError getFieldError(java.lang.String field)
ErrorsgetFieldError in interface ErrorsgetFieldError in class AbstractErrorsfield - the field namenullpublic java.lang.Object getFieldValue(java.lang.String field)
ErrorsAllows for convenient access to user-specified field values, even if there were type mismatches.
getFieldValue in interface Errorsfield - the field namepublic java.lang.Class<?> getFieldType(java.lang.String field)
null values.getFieldType in interface ErrorsgetFieldType in class AbstractErrorsfield - the field namenull if not determinablegetActualFieldValue(java.lang.String)public java.util.Map<java.lang.String,java.lang.Object> getModel()
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.
getModel in interface BindingResultgetObjectName(),
BindingResult.MODEL_KEY_PREFIX,
org.springframework.web.servlet.ModelAndView,
org.springframework.web.servlet.tags.BindTagpublic java.lang.Object getRawFieldValue(java.lang.String field)
BindingResultgetRawFieldValue in interface BindingResultfield - the field to checknull if not knownpublic java.beans.PropertyEditor findEditor(java.lang.String field,
java.lang.Class<?> valueType)
PropertyEditorRegistry's
editor lookup facility, if available.findEditor 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 nonepublic org.springframework.beans.PropertyEditorRegistry getPropertyEditorRegistry()
null.getPropertyEditorRegistry in interface BindingResultnull if none
available for this BindingResultpublic void recordSuppressedField(java.lang.String field)
The 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 java.lang.String[] getSuppressedFields()
Can be used to determine whether any field values were targetting disallowed fields.
getSuppressedFields in interface BindingResultDataBinder.setAllowedFields(java.lang.String...)public boolean equals(java.lang.Object other)
equals in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic abstract java.lang.Object getTarget()
getTarget in interface BindingResultprotected abstract java.lang.Object getActualFieldValue(java.lang.String field)
field - the field to checkprotected java.lang.Object formatFieldValue(java.lang.String field,
java.lang.Object value)
The default implementation simply returns the field value as-is.
field - the field to checkvalue - the value of the field (either a rejected value
other than from a binding error, or an actual field value)