|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.springframework.validation.AbstractErrors
org.springframework.validation.AbstractBindingResult
public abstract class AbstractBindingResult
Abstract implementation of the BindingResult interface and
its super-interface Errors. Encapsulates common management of
ObjectErrors and FieldErrors.
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 | |
|---|---|
protected |
AbstractBindingResult(String objectName)
Create a new AbstractBindingResult instance. |
| Method Summary | |
|---|---|
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()
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. |
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()
Return if there were any errors. |
int |
hashCode()
|
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. |
| 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 |
|---|
protected AbstractBindingResult(String objectName)
objectName - the name of the target objectDefaultMessageCodesResolver| Method Detail |
|---|
public void setMessageCodesResolver(MessageCodesResolver messageCodesResolver)
DefaultMessageCodesResolverpublic MessageCodesResolver getMessageCodesResolver()
public String getObjectName()
Errors
getObjectName in interface Errors
public void reject(String errorCode,
Object[] errorArgs,
String defaultMessage)
Errors
reject in interface ErrorserrorCode - error code, interpretable as a message keyerrorArgs - error arguments, for argument binding via MessageFormat
(can be null)defaultMessage - fallback default message
public void rejectValue(String field,
String errorCode,
Object[] errorArgs,
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 onvenience 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 String[] resolveMessageCodes(String errorCode)
BindingResultCalls the configured MessageCodesResolver with appropriate parameters.
resolveMessageCodes in interface BindingResulterrorCode - the error code to resolve into message codes
public 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 for
public boolean hasErrors()
Errors
hasErrors in interface ErrorshasErrors in class AbstractErrorspublic int getErrorCount()
Errors
getErrorCount in interface ErrorsgetErrorCount in class AbstractErrorspublic List<ObjectError> getAllErrors()
Errors
getAllErrors in interface ErrorsgetAllErrors in class AbstractErrorsObjectError instancespublic List<ObjectError> getGlobalErrors()
Errors
getGlobalErrors in interface Errorspublic ObjectError getGlobalError()
Errors
getGlobalError in interface ErrorsgetGlobalError in class AbstractErrorsnullpublic List<FieldError> getFieldErrors()
Errors
getFieldErrors in interface ErrorsFieldError instancespublic FieldError getFieldError()
Errors
getFieldError in interface ErrorsgetFieldError in class AbstractErrorsnullpublic 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 ErrorsgetFieldErrors in class AbstractErrorsfield - the field name
FieldError instancespublic FieldError getFieldError(String field)
Errors
getFieldError in interface ErrorsgetFieldError in class AbstractErrorsfield - the field name
nullpublic 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
public Class<?> getFieldType(String field)
null values.
getFieldType in interface ErrorsgetFieldType in class AbstractErrorsfield - the field name
null 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. Spring's SimpleFormController will do this for you when rendering its form or success view. When building the ModelAndView yourself, you need to include the attributes from the model Map returned by this method yourself.
getModel in interface BindingResultgetObjectName(),
BindingResult.MODEL_KEY_PREFIX,
ModelAndView,
BindTag,
SimpleFormControllerpublic Object getRawFieldValue(String field)
BindingResult
getRawFieldValue in interface BindingResultfield - the field to check
null if not known
public PropertyEditor findEditor(String field,
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 PropertyEditorRegistry getPropertyEditorRegistry()
null.
getPropertyEditorRegistry in interface BindingResultnull if none
available for this BindingResultpublic void recordSuppressedField(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 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(Object other)
equals in class Objectpublic int hashCode()
hashCode in class Objectpublic abstract Object getTarget()
getTarget in interface BindingResultprotected abstract Object getActualFieldValue(String field)
field - the field to check
protected Object formatFieldValue(String field,
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)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||