public abstract class AbstractBindingResult extends AbstractErrors implements BindingResult, Serializable
BindingResult
interface and
its super-interface Errors
. Encapsulates common management of
ObjectErrors
and FieldErrors
.Errors
,
Serialized FormMODEL_KEY_PREFIX
NESTED_PATH_SEPARATOR
Modifier | Constructor and Description |
---|---|
protected |
AbstractBindingResult(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(Object other) |
PropertyEditor |
findEditor(String field,
Class<?> valueType)
This implementation delegates to the
PropertyEditorRegistry 's
editor lookup facility, if available. |
protected Object |
formatFieldValue(String field,
Object value)
Format the given value for the specified field.
|
protected abstract Object |
getActualFieldValue(String field)
Extract the actual field value for the given field.
|
List<ObjectError> |
getAllErrors()
Get all errors, both global and field ones.
|
int |
getErrorCount()
Determine 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.
|
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)
This default implementation determines the type based on the actual
field value, if any.
|
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.
|
List<ObjectError> |
getGlobalErrors()
Get all global errors.
|
MessageCodesResolver |
getMessageCodesResolver()
Return the strategy to use for resolving errors into message codes.
|
Map<String,Object> |
getModel()
Return a model Map for the obtained state, exposing an Errors
instance as '
MODEL_KEY_PREFIX + objectName'
and the object itself. |
String |
getObjectName()
Return the name of the bound root object.
|
PropertyEditorRegistry |
getPropertyEditorRegistry()
This implementation returns
null . |
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.
|
abstract Object |
getTarget()
Return the wrapped target object.
|
boolean |
hasErrors()
Determine if there were any errors.
|
int |
hashCode() |
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,
Object[] errorArgs,
String defaultMessage)
Register a global error for the entire target object,
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.
|
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.
|
canonicalFieldName, doSetNestedPath, fixedField, getFieldErrorCount, getFieldErrorCount, getGlobalErrorCount, getNestedPath, hasFieldErrors, hasFieldErrors, hasGlobalErrors, isMatchingFieldError, popNestedPath, pushNestedPath, reject, reject, rejectValue, rejectValue, setNestedPath, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getFieldErrorCount, getFieldErrorCount, getGlobalErrorCount, getNestedPath, hasFieldErrors, hasFieldErrors, hasGlobalErrors, popNestedPath, pushNestedPath, reject, reject, rejectValue, rejectValue, setNestedPath
protected AbstractBindingResult(String objectName)
objectName
- the name of the target objectDefaultMessageCodesResolver
public void setMessageCodesResolver(MessageCodesResolver messageCodesResolver)
DefaultMessageCodesResolver
public MessageCodesResolver getMessageCodesResolver()
public String getObjectName()
Errors
getObjectName
in interface Errors
public void reject(String errorCode, @Nullable Object[] errorArgs, @Nullable String defaultMessage)
Errors
reject
in interface Errors
errorCode
- error code, interpretable as a message keyerrorArgs
- error arguments, for argument binding via MessageFormat
(can be null
)defaultMessage
- fallback default messageErrors.rejectValue(String, String, Object[], String)
public void rejectValue(@Nullable String field, String errorCode, @Nullable Object[] errorArgs, @Nullable String defaultMessage)
Errors
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.
rejectValue
in interface Errors
field
- 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.reject(String, Object[], String)
public void addAllErrors(Errors errors)
Errors
Errors
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 Errors
errors
- the Errors
instance to merge inErrors.getAllErrors()
public boolean hasErrors()
Errors
hasErrors
in interface Errors
hasErrors
in class AbstractErrors
Errors.hasGlobalErrors()
,
Errors.hasFieldErrors()
public int getErrorCount()
Errors
getErrorCount
in interface Errors
getErrorCount
in class AbstractErrors
Errors.getGlobalErrorCount()
,
Errors.getFieldErrorCount()
public List<ObjectError> getAllErrors()
Errors
getAllErrors
in interface Errors
getAllErrors
in class AbstractErrors
ObjectError
/FieldError
instancesErrors.getGlobalErrors()
,
Errors.getFieldErrors()
public List<ObjectError> getGlobalErrors()
Errors
getGlobalErrors
in interface Errors
ObjectError
instancesErrors.getFieldErrors()
@Nullable public ObjectError getGlobalError()
Errors
getGlobalError
in interface Errors
getGlobalError
in class AbstractErrors
null
Errors.getFieldError()
public List<FieldError> getFieldErrors()
Errors
getFieldErrors
in interface Errors
FieldError
instancesErrors.getGlobalErrors()
@Nullable public FieldError getFieldError()
Errors
getFieldError
in interface Errors
getFieldError
in class AbstractErrors
null
Errors.getGlobalError()
public List<FieldError> getFieldErrors(String field)
Errors
Implementations may support not only full field names like "address.street" but also pattern matches like "address.*".
getFieldErrors
in interface Errors
getFieldErrors
in class AbstractErrors
field
- the field nameFieldError
instancesErrors.getFieldErrors()
@Nullable public FieldError getFieldError(String field)
Errors
getFieldError
in interface Errors
getFieldError
in class AbstractErrors
field
- the field namenull
Errors.getFieldError()
@Nullable public Object getFieldValue(String field)
Errors
Allows for convenient access to user-specified field values, even if there were type mismatches.
getFieldValue
in interface Errors
field
- the field nameErrors.getFieldType(String)
@Nullable public Class<?> getFieldType(@Nullable String field)
null
values.getFieldType
in interface Errors
getFieldType
in class AbstractErrors
field
- the field namenull
if not determinablegetActualFieldValue(java.lang.String)
public Map<String,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 BindingResult
getObjectName()
,
BindingResult.MODEL_KEY_PREFIX
@Nullable public Object getRawFieldValue(String field)
BindingResult
getRawFieldValue
in interface BindingResult
field
- the field to checknull
if not known@Nullable public PropertyEditor findEditor(@Nullable String field, @Nullable Class<?> valueType)
PropertyEditorRegistry
's
editor lookup facility, if available.findEditor
in interface BindingResult
field
- 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 PropertyEditorRegistry getPropertyEditorRegistry()
null
.getPropertyEditorRegistry
in interface BindingResult
null
if none
available for this BindingResultpublic String[] resolveMessageCodes(String errorCode)
BindingResult
Calls the configured MessageCodesResolver
with appropriate parameters.
resolveMessageCodes
in interface BindingResult
errorCode
- the error code to resolve into message codespublic String[] resolveMessageCodes(String errorCode, @Nullable String field)
BindingResult
Calls the configured MessageCodesResolver
with appropriate parameters.
resolveMessageCodes
in interface BindingResult
errorCode
- the error code to resolve into message codesfield
- the field to resolve message codes forpublic void addError(ObjectError error)
BindingResult
ObjectError
or FieldError
to the errors list.
Intended to be used by cooperating strategies such as BindingErrorProcessor
.
addError
in interface BindingResult
ObjectError
,
FieldError
,
BindingErrorProcessor
public void recordFieldValue(String field, Class<?> type, @Nullable Object value)
BindingResult
To 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 BindingResult
field
- the field to record the value fortype
- the type of the fieldvalue
- the original valuepublic void recordSuppressedField(String field)
The data binder invokes this for each field value that was detected to target a disallowed field.
recordSuppressedField
in interface BindingResult
DataBinder.setAllowedFields(java.lang.String...)
public String[] getSuppressedFields()
Can be used to determine whether any field values were targeting disallowed fields.
getSuppressedFields
in interface BindingResult
DataBinder.setAllowedFields(java.lang.String...)
@Nullable public abstract Object getTarget()
getTarget
in interface BindingResult
@Nullable protected abstract Object getActualFieldValue(String field)
field
- the field to check@Nullable protected Object formatFieldValue(String field, @Nullable 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)