接口 Errors
- 所有已知子接口:
BindingResult
- 所有已知实现类:
AbstractBindingResult
,AbstractErrors
,AbstractPropertyBindingResult
,BeanPropertyBindingResult
,BindException
,DirectFieldBindingResult
,EscapedErrors
,MapBindingResult
,WebExchangeBindException
public interface Errors
Stores and exposes information about data-binding and validation errors for a specific object.Field names can be properties of the target object (e.g. "name" when binding to a customer object), or nested fields in case of subobjects (e.g. "address.street"). Supports subtree navigation via
setNestedPath(String)
: for example, anAddressValidator
validates "address", not being aware that this is a subobject of customer.Note:
Errors
objects are single-threaded.- 作者:
- Rod Johnson, Juergen Hoeller
- 另请参阅:
setNestedPath(java.lang.String)
,BindException
,DataBinder
,ValidationUtils
字段概要
字段 修饰符和类型 字段 说明 static String
NESTED_PATH_SEPARATOR
The separator between path elements in a nested path, for example in "customer.name" or "customer.address.street".
方法概要
所有方法 实例方法 抽象方法 修饰符和类型 方法 说明 void
addAllErrors(Errors errors)
Add all errors from the givenErrors
instance to thisErrors
instance.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.int
getFieldErrorCount()
Return the number of errors associated with a field.int
getFieldErrorCount(String field)
Return the number of errors associated with the given field.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)
Return the type of a given field.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.int
getGlobalErrorCount()
Return the number of global errors.List<ObjectError>
getGlobalErrors()
Get all global errors.String
getNestedPath()
Return the current nested path of thisErrors
object.String
getObjectName()
Return the name of the bound root object.boolean
hasErrors()
Return if there were any errors.boolean
hasFieldErrors()
Are there any field errors?boolean
hasFieldErrors(String field)
Are there any errors associated with the given field?boolean
hasGlobalErrors()
Are there any global errors?void
popNestedPath()
Pop the former nested path from the nested path stack.void
pushNestedPath(String subPath)
Push the given sub path onto the nested path stack.void
reject(String errorCode)
Register a global error for the entire target object, using the given error description.void
reject(String errorCode, Object[] errorArgs, String defaultMessage)
Register a global error for the entire target object, using the given error description.void
reject(String errorCode, String defaultMessage)
Register a global error for the entire target object, using the given error description.void
rejectValue(String field, String errorCode)
Register a field error for the specified field of the current object (respecting the current nested path, if any), 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.void
rejectValue(String field, String errorCode, 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.void
setNestedPath(String nestedPath)
Allow context to be changed so that standard validators can validate subtrees.
字段详细资料
NESTED_PATH_SEPARATOR
static final String NESTED_PATH_SEPARATOR
The separator between path elements in a nested path, for example in "customer.name" or "customer.address.street"."." = same as the
nested property separator
in the beans package.- 另请参阅:
- 常量字段值
方法详细资料
getObjectName
String getObjectName()
Return the name of the bound root object.
setNestedPath
void setNestedPath(String nestedPath)
Allow context to be changed so that standard validators can validate subtrees. Reject calls prepend the given path to the field names.For example, an address validator could validate the subobject "address" of a customer object.
- 参数:
nestedPath
- nested path within this object, e.g. "address" (defaults to "",null
is also acceptable). Can end with a dot: both "address" and "address." are valid.
getNestedPath
String getNestedPath()
Return the current nested path of thisErrors
object.Returns a nested path with a dot, i.e. "address.", for easy building of concatenated paths. Default is an empty String.
pushNestedPath
void pushNestedPath(String subPath)
Push the given sub path onto the nested path stack.A
popNestedPath()
call will reset the original nested path before the correspondingpushNestedPath(String)
call.Using the nested path stack allows to set temporary nested paths for subobjects without having to worry about a temporary path holder.
For example: current path "spouse.", pushNestedPath("child") -> result path "spouse.child."; popNestedPath() -> "spouse." again.
- 参数:
subPath
- the sub path to push onto the nested path stack- 另请参阅:
popNestedPath()
popNestedPath
void popNestedPath() throws IllegalStateException
Pop the former nested path from the nested path stack.- 抛出:
IllegalStateException
- if there is no former nested path on the stack- 另请参阅:
pushNestedPath(java.lang.String)
reject
void reject(String errorCode)
Register a global error for the entire target object, using the given error description.- 参数:
errorCode
- error code, interpretable as a message key
reject
void reject(String errorCode, String defaultMessage)
Register a global error for the entire target object, using the given error description.- 参数:
errorCode
- error code, interpretable as a message keydefaultMessage
- fallback default message
reject
void reject(String errorCode, @Nullable Object[] errorArgs, @Nullable String defaultMessage)
Register a global error for the entire target object, using the given error description.- 参数:
errorCode
- error code, interpretable as a message keyerrorArgs
- error arguments, for argument binding via MessageFormat (can benull
)defaultMessage
- fallback default message
rejectValue
void rejectValue(@Nullable String field, String errorCode)
Register 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
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.- 参数:
field
- the field name (may benull
or empty String)errorCode
- error code, interpretable as a message key- 另请参阅:
getNestedPath()
rejectValue
void rejectValue(@Nullable String field, String errorCode, 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.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.- 参数:
field
- the field name (may benull
or empty String)errorCode
- error code, interpretable as a message keydefaultMessage
- fallback default message- 另请参阅:
getNestedPath()
rejectValue
void rejectValue(@Nullable String field, String errorCode, @Nullable Object[] errorArgs, @Nullable 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.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.- 参数:
field
- the field name (may benull
or empty String)errorCode
- error code, interpretable as a message keyerrorArgs
- error arguments, for argument binding via MessageFormat (can benull
)defaultMessage
- fallback default message- 另请参阅:
getNestedPath()
addAllErrors
void addAllErrors(Errors errors)
Add all errors from the givenErrors
instance to thisErrors
instance.This is a convenience method to avoid repeated
reject(..)
calls for merging anErrors
instance into anotherErrors
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 thisErrors
instance.- 参数:
errors
- theErrors
instance to merge in
hasErrors
boolean hasErrors()
Return if there were any errors.
getErrorCount
int getErrorCount()
Return the total number of errors.
getAllErrors
List<ObjectError> getAllErrors()
Get all errors, both global and field ones.- 返回:
- a list of
ObjectError
instances
hasGlobalErrors
boolean hasGlobalErrors()
Are there any global errors?- 返回:
true
if there are any global errors- 另请参阅:
hasFieldErrors()
getGlobalErrorCount
int getGlobalErrorCount()
Return the number of global errors.- 返回:
- the number of global errors
- 另请参阅:
getFieldErrorCount()
getGlobalErrors
List<ObjectError> getGlobalErrors()
Get all global errors.- 返回:
- a list of
ObjectError
instances
getGlobalError
@Nullable ObjectError getGlobalError()
Get the first global error, if any.- 返回:
- the global error, or
null
hasFieldErrors
boolean hasFieldErrors()
Are there any field errors?- 返回:
true
if there are any errors associated with a field- 另请参阅:
hasGlobalErrors()
getFieldErrorCount
int getFieldErrorCount()
Return the number of errors associated with a field.- 返回:
- the number of errors associated with a field
- 另请参阅:
getGlobalErrorCount()
getFieldErrors
List<FieldError> getFieldErrors()
Get all errors associated with a field.- 返回:
- a List of
FieldError
instances
getFieldError
@Nullable FieldError getFieldError()
Get the first error associated with a field, if any.- 返回:
- the field-specific error, or
null
hasFieldErrors
boolean hasFieldErrors(String field)
Are there any errors associated with the given field?- 参数:
field
- the field name- 返回:
true
if there were any errors associated with the given field
getFieldErrorCount
int getFieldErrorCount(String field)
Return the number of errors associated with the given field.- 参数:
field
- the field name- 返回:
- the number of errors associated with the given field
getFieldErrors
List<FieldError> getFieldErrors(String field)
Get 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.*".
- 参数:
field
- the field name- 返回:
- a List of
FieldError
instances
getFieldError
@Nullable FieldError getFieldError(String field)
Get the first error associated with the given field, if any.- 参数:
field
- the field name- 返回:
- the field-specific error, or
null
getFieldValue
@Nullable 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.Allows for convenient access to user-specified field values, even if there were type mismatches.
- 参数:
field
- the field name- 返回:
- the current value of the given field
getFieldType
@Nullable Class<?> getFieldType(String field)
Return the type of a given field.Implementations should be able to determine the type even when the field value is
null
, for example from some associated descriptor.- 参数:
field
- the field name- 返回:
- the type of the field, or
null
if not determinable