Interface Errors
- All Known Subinterfaces:
BindingResult
- All Known Implementing Classes:
AbstractBindingResult
,AbstractErrors
,AbstractPropertyBindingResult
,BeanPropertyBindingResult
,BindException
,DirectFieldBindingResult
,EscapedErrors
,MapBindingResult
,MethodArgumentNotValidException
,WebExchangeBindException
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.
- Author:
- Rod Johnson, Juergen Hoeller
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The separator between path elements in a nested path, for example in "customer.name" or "customer.address.street". -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAllErrors
(Errors errors) Add all errors from the givenErrors
instance to thisErrors
instance.Get all errors, both global and field ones.int
Return the total number of errors.Get the first error associated with a field, if any.getFieldError
(String field) Get the first error associated with the given field, if any.int
Return the number of errors associated with a field.int
getFieldErrorCount
(String field) Return the number of errors associated with the given field.Get all errors associated with a field.getFieldErrors
(String field) Get all errors associated with the given field.Class<?>
getFieldType
(String field) Return the type of a given field.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.Get the first global error, if any.int
Return the number of global errors.Get all global errors.Return the current nested path of thisErrors
object.Return the name of the bound root object.boolean
Return if there were any errors.boolean
Are there any field errors?boolean
hasFieldErrors
(String field) Are there any errors associated with the given field?boolean
Are there any global errors?void
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
Register a global error for the entire target object, using the given error description.void
Register a global error for the entire target object, using the given error description.void
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.
-
Field Details
-
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.- See Also:
-
-
Method Details
-
getObjectName
String getObjectName()Return the name of the bound root object. -
setNestedPath
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.
- Parameters:
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
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.
- Parameters:
subPath
- the sub path to push onto the nested path stack- See Also:
-
popNestedPath
Pop the former nested path from the nested path stack.- Throws:
IllegalStateException
- if there is no former nested path on the stack- See Also:
-
reject
Register a global error for the entire target object, using the given error description.- Parameters:
errorCode
- error code, interpretable as a message key
-
reject
Register a global error for the entire target object, using the given error description.- Parameters:
errorCode
- error code, interpretable as a message keydefaultMessage
- fallback default message
-
reject
Register a global error for the entire target object, using the given error description.- Parameters:
errorCode
- error code, interpretable as a message keyerrorArgs
- error arguments, for argument binding via MessageFormat (can benull
)defaultMessage
- fallback default message
-
rejectValue
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.- Parameters:
field
- the field name (may benull
or empty String)errorCode
- error code, interpretable as a message key- See Also:
-
rejectValue
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.- Parameters:
field
- the field name (may benull
or empty String)errorCode
- error code, interpretable as a message keydefaultMessage
- fallback default message- See Also:
-
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.- Parameters:
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- See Also:
-
addAllErrors
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.- Parameters:
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.- Returns:
- a list of
ObjectError
instances
-
hasGlobalErrors
boolean hasGlobalErrors()Are there any global errors?- Returns:
true
if there are any global errors- See Also:
-
getGlobalErrorCount
int getGlobalErrorCount()Return the number of global errors.- Returns:
- the number of global errors
- See Also:
-
getGlobalErrors
List<ObjectError> getGlobalErrors()Get all global errors.- Returns:
- a list of
ObjectError
instances
-
getGlobalError
Get the first global error, if any.- Returns:
- the global error, or
null
-
hasFieldErrors
boolean hasFieldErrors()Are there any field errors?- Returns:
true
if there are any errors associated with a field- See Also:
-
getFieldErrorCount
int getFieldErrorCount()Return the number of errors associated with a field.- Returns:
- the number of errors associated with a field
- See Also:
-
getFieldErrors
List<FieldError> getFieldErrors()Get all errors associated with a field.- Returns:
- a List of
FieldError
instances
-
getFieldError
Get the first error associated with a field, if any.- Returns:
- the field-specific error, or
null
-
hasFieldErrors
Are there any errors associated with the given field?- Parameters:
field
- the field name- Returns:
true
if there were any errors associated with the given field
-
getFieldErrorCount
Return the number of errors associated with the given field.- Parameters:
field
- the field name- Returns:
- the number of errors associated with the given field
-
getFieldErrors
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.*".
- Parameters:
field
- the field name- Returns:
- a List of
FieldError
instances
-
getFieldError
Get the first error associated with the given field, if any.- Parameters:
field
- the field name- Returns:
- the field-specific error, or
null
-
getFieldValue
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.
- Parameters:
field
- the field name- Returns:
- the current value of the given field
-
getFieldType
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.- Parameters:
field
- the field name- Returns:
- the type of the field, or
null
if not determinable
-