Class AbstractBindingResult
- java.lang.Object
- org.springframework.validation.AbstractErrors
- org.springframework.validation.AbstractBindingResult
- All Implemented Interfaces:
Serializable,BindingResult,Errors
- Direct Known Subclasses:
AbstractPropertyBindingResult,MapBindingResult
public abstract class AbstractBindingResult extends AbstractErrors implements BindingResult, Serializable
Abstract implementation of theBindingResultinterface and its super-interfaceErrors. Encapsulates common management ofObjectErrorsandFieldErrors.- Since:
- 2.0
- Author:
- Juergen Hoeller, Rob Harrop
- See Also:
Errors, 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 Modifier Constructor Description protectedAbstractBindingResult(String objectName)Create a new AbstractBindingResult instance.
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidaddAllErrors(Errors errors)Add all errors from the givenErrorsinstance to thisErrorsinstance.voidaddError(ObjectError error)Add a customObjectErrororFieldErrorto the errors list.booleanequals(Object other)PropertyEditorfindEditor(String field, Class<?> valueType)This implementation delegates to thePropertyEditorRegistry's editor lookup facility, if available.protected ObjectformatFieldValue(String field, Object value)Format the given value for the specified field.protected abstract ObjectgetActualFieldValue(String field)Extract the actual field value for the given field.List<ObjectError>getAllErrors()Get all errors, both global and field ones.intgetErrorCount()Return the total number of errors.FieldErrorgetFieldError()Get the first error associated with a field, if any.FieldErrorgetFieldError(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.ObjectgetFieldValue(String field)Return the current value of the given field, either the current bean property value or a rejected update from the last binding.ObjectErrorgetGlobalError()Get the first global error, if any.List<ObjectError>getGlobalErrors()Get all global errors.MessageCodesResolvergetMessageCodesResolver()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.StringgetObjectName()Return the name of the bound root object.PropertyEditorRegistrygetPropertyEditorRegistry()This implementation returnsnull.ObjectgetRawFieldValue(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 ObjectgetTarget()Return the wrapped target object.booleanhasErrors()Return if there were any errors.inthashCode()voidrecordSuppressedField(String field)Mark the specified disallowed field as suppressed.voidreject(String errorCode, Object[] errorArgs, String defaultMessage)Register a global error for the entire target object, using the given error description.voidrejectValue(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.voidsetMessageCodesResolver(MessageCodesResolver messageCodesResolver)Set the strategy to use for resolving errors into message codes.Methods inherited from class org.springframework.validation.AbstractErrors
canonicalFieldName, doSetNestedPath, fixedField, getFieldErrorCount, getFieldErrorCount, getGlobalErrorCount, getNestedPath, hasFieldErrors, hasFieldErrors, hasGlobalErrors, isMatchingFieldError, popNestedPath, pushNestedPath, reject, reject, rejectValue, rejectValue, setNestedPath, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.springframework.validation.Errors
getFieldErrorCount, getFieldErrorCount, getGlobalErrorCount, getNestedPath, hasFieldErrors, hasFieldErrors, hasGlobalErrors, popNestedPath, pushNestedPath, reject, reject, rejectValue, rejectValue, setNestedPath
Constructor Detail
AbstractBindingResult
protected AbstractBindingResult(String objectName)
Create a new AbstractBindingResult instance.- Parameters:
objectName- the name of the target object- See Also:
DefaultMessageCodesResolver
Method Detail
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.
getObjectName
public String getObjectName()
Description copied from interface:ErrorsReturn the name of the bound root object.- Specified by:
getObjectNamein interfaceErrors
reject
public void reject(String errorCode, Object[] errorArgs, String defaultMessage)
Description copied from interface:ErrorsRegister a global error for the entire target object, using the given error description.
rejectValue
public void rejectValue(String field, String errorCode, Object[] errorArgs, String defaultMessage)
Description copied from interface:ErrorsRegister 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
nullor 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:
rejectValuein interfaceErrors- Parameters:
field- the field name (may benullor 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()
addError
public void addError(ObjectError error)
Description copied from interface:BindingResultAdd a customObjectErrororFieldErrorto the errors list.Intended to be used by cooperating strategies such as
BindingErrorProcessor.- Specified by:
addErrorin interfaceBindingResult- See Also:
ObjectError,FieldError,BindingErrorProcessor
addAllErrors
public void addAllErrors(Errors errors)
Description copied from interface:ErrorsAdd all errors from the givenErrorsinstance to thisErrorsinstance.This is a convenience method to avoid repeated
reject(..)calls for merging anErrorsinstance into anotherErrorsinstance.Note that the passed-in
Errorsinstance is supposed to refer to the same target object, or at least contain compatible errors that apply to the target object of thisErrorsinstance.- Specified by:
addAllErrorsin interfaceErrors- Parameters:
errors- theErrorsinstance to merge in
resolveMessageCodes
public String[] resolveMessageCodes(String errorCode)
Description copied from interface:BindingResultResolve the given error code into message codes.Calls the configured
MessageCodesResolverwith appropriate parameters.- Specified by:
resolveMessageCodesin 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:BindingResultResolve the given error code into message codes for the given field.Calls the configured
MessageCodesResolverwith appropriate parameters.- Specified by:
resolveMessageCodesin interfaceBindingResult- Parameters:
errorCode- the error code to resolve into message codesfield- the field to resolve message codes for- Returns:
- the resolved message codes
hasErrors
public boolean hasErrors()
Description copied from interface:ErrorsReturn if there were any errors.- Specified by:
hasErrorsin interfaceErrors- Overrides:
hasErrorsin classAbstractErrors
getErrorCount
public int getErrorCount()
Description copied from interface:ErrorsReturn the total number of errors.- Specified by:
getErrorCountin interfaceErrors- Overrides:
getErrorCountin classAbstractErrors
getAllErrors
public List<ObjectError> getAllErrors()
Description copied from interface:ErrorsGet all errors, both global and field ones.- Specified by:
getAllErrorsin interfaceErrors- Overrides:
getAllErrorsin classAbstractErrors- Returns:
- List of
ObjectErrorinstances
getGlobalErrors
public List<ObjectError> getGlobalErrors()
Description copied from interface:ErrorsGet all global errors.- Specified by:
getGlobalErrorsin interfaceErrors- Returns:
- List of ObjectError instances
getGlobalError
public ObjectError getGlobalError()
Description copied from interface:ErrorsGet the first global error, if any.- Specified by:
getGlobalErrorin interfaceErrors- Overrides:
getGlobalErrorin classAbstractErrors- Returns:
- the global error, or
null
getFieldErrors
public List<FieldError> getFieldErrors()
Description copied from interface:ErrorsGet all errors associated with a field.- Specified by:
getFieldErrorsin interfaceErrors- Returns:
- a List of
FieldErrorinstances
getFieldError
public FieldError getFieldError()
Description copied from interface:ErrorsGet the first error associated with a field, if any.- Specified by:
getFieldErrorin interfaceErrors- Overrides:
getFieldErrorin classAbstractErrors- Returns:
- the field-specific error, or
null
getFieldErrors
public List<FieldError> getFieldErrors(String field)
Description copied from interface:ErrorsGet 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:
getFieldErrorsin interfaceErrors- Overrides:
getFieldErrorsin classAbstractErrors- Parameters:
field- the field name- Returns:
- a List of
FieldErrorinstances
getFieldError
public FieldError getFieldError(String field)
Description copied from interface:ErrorsGet the first error associated with the given field, if any.- Specified by:
getFieldErrorin interfaceErrors- Overrides:
getFieldErrorin classAbstractErrors- Parameters:
field- the field name- Returns:
- the field-specific error, or
null
getFieldValue
public Object getFieldValue(String field)
Description copied from interface:ErrorsReturn 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:
getFieldValuein interfaceErrors- Parameters:
field- the field name- Returns:
- the current value of the given field
getFieldType
public Class<?> getFieldType(String field)
This default implementation determines the type based on the actual field value, if any. Subclasses should override this to determine the type from a descriptor, even fornullvalues.- Specified by:
getFieldTypein interfaceErrors- Overrides:
getFieldTypein classAbstractErrors- Parameters:
field- the field name- Returns:
- the type of the field, or
nullif not determinable - See Also:
getActualFieldValue(java.lang.String)
getModel
public 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.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.
- Specified by:
getModelin interfaceBindingResult- See Also:
getObjectName(),BindingResult.MODEL_KEY_PREFIX,ModelAndView,BindTag
getRawFieldValue
public Object getRawFieldValue(String field)
Description copied from interface:BindingResultExtract the raw field value for the given field. Typically used for comparison purposes.- Specified by:
getRawFieldValuein interfaceBindingResult- Parameters:
field- the field to check- Returns:
- the current value of the field in its raw form, or
nullif not known
findEditor
public PropertyEditor findEditor(String field, Class<?> valueType)
This implementation delegates to thePropertyEditorRegistry's editor lookup facility, if available.- Specified by:
findEditorin interfaceBindingResult- Parameters:
field- the path of the property (name or nested path), ornullif looking for an editor for all properties of the given typevalueType- the type of the property (can benullif a property is given but should be specified in any case for consistency checking)- Returns:
- the registered editor, or
nullif none
getPropertyEditorRegistry
public PropertyEditorRegistry getPropertyEditorRegistry()
This implementation returnsnull.- Specified by:
getPropertyEditorRegistryin interfaceBindingResult- Returns:
- the PropertyEditorRegistry, or
nullif none available for this BindingResult
recordSuppressedField
public void recordSuppressedField(String field)
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:
recordSuppressedFieldin interfaceBindingResult- See Also:
DataBinder.setAllowedFields(java.lang.String...)
getSuppressedFields
public String[] getSuppressedFields()
Return the list of fields that were suppressed during the bind process.Can be used to determine whether any field values were targetting disallowed fields.
- Specified by:
getSuppressedFieldsin interfaceBindingResult- See Also:
DataBinder.setAllowedFields(java.lang.String...)
getTarget
public abstract Object getTarget()
Return the wrapped target object.- Specified by:
getTargetin interfaceBindingResult
getActualFieldValue
protected abstract Object getActualFieldValue(String field)
Extract the actual field value for the given field.- Parameters:
field- the field to check- Returns:
- the current value of the field
formatFieldValue
protected Object formatFieldValue(String field, Object value)
Format the given value for the specified field.The default implementation simply returns the field value as-is.
- Parameters:
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)- Returns:
- the formatted value