类 AbstractBindingResult
- java.lang.Object
- org.springframework.validation.AbstractErrors
- org.springframework.validation.AbstractBindingResult
- 所有已实现的接口:
Serializable,BindingResult,Errors
public abstract class AbstractBindingResult extends AbstractErrors implements BindingResult, Serializable
Abstract implementation of theBindingResultinterface and its super-interfaceErrors. Encapsulates common management ofObjectErrorsandFieldErrors.
字段概要
从接口继承的字段 org.springframework.validation.BindingResult
MODEL_KEY_PREFIX
从接口继承的字段 org.springframework.validation.Errors
NESTED_PATH_SEPARATOR
构造器概要
构造器 限定符 构造器 说明 protectedAbstractBindingResult(String objectName)Create a new AbstractBindingResult instance.
方法概要
所有方法 实例方法 抽象方法 具体方法 修饰符和类型 方法 说明 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()voidrecordFieldValue(String field, Class<?> type, Object value)Record the given value for the specified field.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.从类继承的方法 org.springframework.validation.AbstractErrors
canonicalFieldName, doSetNestedPath, fixedField, getFieldErrorCount, getFieldErrorCount, getGlobalErrorCount, getNestedPath, hasFieldErrors, hasFieldErrors, hasGlobalErrors, isMatchingFieldError, popNestedPath, pushNestedPath, reject, reject, rejectValue, rejectValue, setNestedPath, toString
从接口继承的方法 org.springframework.validation.Errors
getFieldErrorCount, getFieldErrorCount, getGlobalErrorCount, getNestedPath, hasFieldErrors, hasFieldErrors, hasGlobalErrors, popNestedPath, pushNestedPath, reject, reject, rejectValue, rejectValue, setNestedPath
构造器详细资料
AbstractBindingResult
protected AbstractBindingResult(String objectName)
Create a new AbstractBindingResult instance.- 参数:
objectName- the name of the target object- 另请参阅:
DefaultMessageCodesResolver
方法详细资料
setMessageCodesResolver
public void setMessageCodesResolver(MessageCodesResolver messageCodesResolver)
Set the strategy to use for resolving errors into message codes. Default is DefaultMessageCodesResolver.
getMessageCodesResolver
public MessageCodesResolver getMessageCodesResolver()
Return the strategy to use for resolving errors into message codes.
getObjectName
public String getObjectName()
从接口复制的说明:ErrorsReturn the name of the bound root object.- 指定者:
getObjectName在接口中Errors
reject
public void reject(String errorCode, @Nullable Object[] errorArgs, @Nullable String defaultMessage)
从接口复制的说明:ErrorsRegister a global error for the entire target object, using the given error description.
rejectValue
public void rejectValue(@Nullable String field, String errorCode, @Nullable Object[] errorArgs, @Nullable String defaultMessage)
从接口复制的说明: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.- 指定者:
rejectValue在接口中Errors- 参数:
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- 另请参阅:
Errors.getNestedPath()
addAllErrors
public void addAllErrors(Errors errors)
从接口复制的说明: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.- 指定者:
addAllErrors在接口中Errors- 参数:
errors- theErrorsinstance to merge in
hasErrors
public boolean hasErrors()
从接口复制的说明:ErrorsReturn if there were any errors.- 指定者:
hasErrors在接口中Errors- 覆盖:
hasErrors在类中AbstractErrors
getErrorCount
public int getErrorCount()
从接口复制的说明:ErrorsReturn the total number of errors.- 指定者:
getErrorCount在接口中Errors- 覆盖:
getErrorCount在类中AbstractErrors
getAllErrors
public List<ObjectError> getAllErrors()
从接口复制的说明:ErrorsGet all errors, both global and field ones.- 指定者:
getAllErrors在接口中Errors- 覆盖:
getAllErrors在类中AbstractErrors- 返回:
- a list of
ObjectErrorinstances
getGlobalErrors
public List<ObjectError> getGlobalErrors()
从接口复制的说明:ErrorsGet all global errors.- 指定者:
getGlobalErrors在接口中Errors- 返回:
- a list of
ObjectErrorinstances
getGlobalError
@Nullable public ObjectError getGlobalError()
从接口复制的说明:ErrorsGet the first global error, if any.- 指定者:
getGlobalError在接口中Errors- 覆盖:
getGlobalError在类中AbstractErrors- 返回:
- the global error, or
null
getFieldErrors
public List<FieldError> getFieldErrors()
从接口复制的说明:ErrorsGet all errors associated with a field.- 指定者:
getFieldErrors在接口中Errors- 返回:
- a List of
FieldErrorinstances
getFieldError
@Nullable public FieldError getFieldError()
从接口复制的说明:ErrorsGet the first error associated with a field, if any.- 指定者:
getFieldError在接口中Errors- 覆盖:
getFieldError在类中AbstractErrors- 返回:
- the field-specific error, or
null
getFieldErrors
public List<FieldError> getFieldErrors(String field)
从接口复制的说明: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.*".
- 指定者:
getFieldErrors在接口中Errors- 覆盖:
getFieldErrors在类中AbstractErrors- 参数:
field- the field name- 返回:
- a List of
FieldErrorinstances
getFieldError
@Nullable public FieldError getFieldError(String field)
从接口复制的说明:ErrorsGet the first error associated with the given field, if any.- 指定者:
getFieldError在接口中Errors- 覆盖:
getFieldError在类中AbstractErrors- 参数:
field- the field name- 返回:
- the field-specific error, or
null
getFieldValue
@Nullable public Object getFieldValue(String field)
从接口复制的说明: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.
- 指定者:
getFieldValue在接口中Errors- 参数:
field- the field name- 返回:
- the current value of the given field
getFieldType
@Nullable public Class<?> getFieldType(@Nullable 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.- 指定者:
getFieldType在接口中Errors- 覆盖:
getFieldType在类中AbstractErrors- 参数:
field- the field name- 返回:
- the type of the field, or
nullif not determinable - 另请参阅:
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.
- 指定者:
getModel在接口中BindingResult- 另请参阅:
getObjectName(),BindingResult.MODEL_KEY_PREFIX
getRawFieldValue
@Nullable public Object getRawFieldValue(String field)
从接口复制的说明:BindingResultExtract the raw field value for the given field. Typically used for comparison purposes.- 指定者:
getRawFieldValue在接口中BindingResult- 参数:
field- the field to check- 返回:
- the current value of the field in its raw form, or
nullif not known
findEditor
@Nullable public PropertyEditor findEditor(@Nullable String field, @Nullable Class<?> valueType)
This implementation delegates to thePropertyEditorRegistry's editor lookup facility, if available.- 指定者:
findEditor在接口中BindingResult- 参数:
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)- 返回:
- the registered editor, or
nullif none
getPropertyEditorRegistry
@Nullable public PropertyEditorRegistry getPropertyEditorRegistry()
This implementation returnsnull.- 指定者:
getPropertyEditorRegistry在接口中BindingResult- 返回:
- the PropertyEditorRegistry, or
nullif none available for this BindingResult
resolveMessageCodes
public String[] resolveMessageCodes(String errorCode)
从接口复制的说明:BindingResultResolve the given error code into message codes.Calls the configured
MessageCodesResolverwith appropriate parameters.- 指定者:
resolveMessageCodes在接口中BindingResult- 参数:
errorCode- the error code to resolve into message codes- 返回:
- the resolved message codes
resolveMessageCodes
public String[] resolveMessageCodes(String errorCode, @Nullable String field)
从接口复制的说明:BindingResultResolve the given error code into message codes for the given field.Calls the configured
MessageCodesResolverwith appropriate parameters.- 指定者:
resolveMessageCodes在接口中BindingResult- 参数:
errorCode- the error code to resolve into message codesfield- the field to resolve message codes for- 返回:
- the resolved message codes
addError
public void addError(ObjectError error)
从接口复制的说明:BindingResultAdd a customObjectErrororFieldErrorto the errors list.Intended to be used by cooperating strategies such as
BindingErrorProcessor.- 指定者:
addError在接口中BindingResult- 另请参阅:
ObjectError,FieldError,BindingErrorProcessor
recordFieldValue
public void recordFieldValue(String field, Class<?> type, @Nullable Object value)
从接口复制的说明:BindingResultRecord the given value for the specified field.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在接口中BindingResult- 参数:
field- the field to record the value fortype- the type of the fieldvalue- the original value
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.
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 targeting disallowed fields.
getTarget
@Nullable public abstract Object getTarget()
Return the wrapped target object.- 指定者:
getTarget在接口中BindingResult
getActualFieldValue
@Nullable protected abstract Object getActualFieldValue(String field)
Extract the actual field value for the given field.- 参数:
field- the field to check- 返回:
- the current value of the field
formatFieldValue
@Nullable protected Object formatFieldValue(String field, @Nullable Object value)
Format the given value for the specified field.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)- 返回:
- the formatted value