public interface Errors
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, an
AddressValidator
validates "address", not being aware
that this is a subobject of customer.
Note: Errors
objects are single-threaded.
setNestedPath(java.lang.String)
,
BindException
,
DataBinder
,
ValidationUtils
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NESTED_PATH_SEPARATOR
The separator between path elements in a nested path,
for example in "customer.name" or "customer.address.street".
|
Modifier and Type | Method and Description |
---|---|
void |
addAllErrors(Errors errors)
Add all errors from the given
Errors instance to this
Errors instance. |
java.util.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(java.lang.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(java.lang.String field)
Return the number of errors associated with the given field.
|
java.util.List<FieldError> |
getFieldErrors()
Get all errors associated with a field.
|
java.util.List<FieldError> |
getFieldErrors(java.lang.String field)
Get all errors associated with the given field.
|
java.lang.Class<?> |
getFieldType(java.lang.String field)
Return the type of a given field.
|
java.lang.Object |
getFieldValue(java.lang.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.
|
java.util.List<ObjectError> |
getGlobalErrors()
Get all global errors.
|
java.lang.String |
getNestedPath()
Return the current nested path of this
Errors object. |
java.lang.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(java.lang.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(java.lang.String subPath)
Push the given sub path onto the nested path stack.
|
void |
reject(java.lang.String errorCode)
Register a global error for the entire target object,
using the given error description.
|
void |
reject(java.lang.String errorCode,
java.lang.Object[] errorArgs,
java.lang.String defaultMessage)
Register a global error for the entire target object,
using the given error description.
|
void |
reject(java.lang.String errorCode,
java.lang.String defaultMessage)
Register a global error for the entire target object,
using the given error description.
|
void |
rejectValue(java.lang.String field,
java.lang.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(java.lang.String field,
java.lang.String errorCode,
java.lang.Object[] errorArgs,
java.lang.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(java.lang.String field,
java.lang.String errorCode,
java.lang.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(java.lang.String nestedPath)
Allow context to be changed so that standard validators can validate
subtrees.
|
static final java.lang.String NESTED_PATH_SEPARATOR
"." = same as the
nested property separator
in the beans package.
java.lang.String getObjectName()
void setNestedPath(java.lang.String nestedPath)
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.java.lang.String getNestedPath()
Errors
object.
Returns a nested path with a dot, i.e. "address.", for easy building of concatenated paths. Default is an empty String.
void pushNestedPath(java.lang.String subPath)
A popNestedPath()
call will reset the original
nested path before the corresponding
pushNestedPath(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 stackpopNestedPath()
void popNestedPath() throws java.lang.IllegalStateException
java.lang.IllegalStateException
- if there is no former nested path on the stackpushNestedPath(java.lang.String)
void reject(java.lang.String errorCode)
errorCode
- error code, interpretable as a message keyvoid reject(java.lang.String errorCode, java.lang.String defaultMessage)
errorCode
- error code, interpretable as a message keydefaultMessage
- fallback default messagevoid reject(java.lang.String errorCode, java.lang.Object[] errorArgs, java.lang.String defaultMessage)
errorCode
- error code, interpretable as a message keyerrorArgs
- error arguments, for argument binding via MessageFormat
(can be null
)defaultMessage
- fallback default messagevoid rejectValue(java.lang.String field, java.lang.String errorCode)
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 be null
or empty String)errorCode
- error code, interpretable as a message keygetNestedPath()
void rejectValue(java.lang.String field, java.lang.String errorCode, java.lang.String defaultMessage)
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 be null
or empty String)errorCode
- error code, interpretable as a message keydefaultMessage
- fallback default messagegetNestedPath()
void rejectValue(java.lang.String field, java.lang.String errorCode, java.lang.Object[] errorArgs, java.lang.String defaultMessage)
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 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 messagegetNestedPath()
void addAllErrors(Errors errors)
Errors
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.
errors
- the Errors
instance to merge inboolean hasErrors()
int getErrorCount()
java.util.List<ObjectError> getAllErrors()
ObjectError
instancesboolean hasGlobalErrors()
true
if there are any global errorshasFieldErrors()
int getGlobalErrorCount()
getFieldErrorCount()
java.util.List<ObjectError> getGlobalErrors()
ObjectError getGlobalError()
null
boolean hasFieldErrors()
true
if there are any errors associated with a fieldhasGlobalErrors()
int getFieldErrorCount()
getGlobalErrorCount()
java.util.List<FieldError> getFieldErrors()
FieldError
instancesFieldError getFieldError()
null
boolean hasFieldErrors(java.lang.String field)
field
- the field nametrue
if there were any errors associated with the given fieldint getFieldErrorCount(java.lang.String field)
field
- the field namejava.util.List<FieldError> getFieldErrors(java.lang.String field)
Implementations should support not only full field names like "name" but also pattern matches like "na*" or "address.*".
field
- the field nameFieldError
instancesFieldError getFieldError(java.lang.String field)
field
- the field namenull
java.lang.Object getFieldValue(java.lang.String field)
Allows for convenient access to user-specified field values, even if there were type mismatches.
field
- the field namejava.lang.Class<?> getFieldType(java.lang.String 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 namenull
if not determinable