| org.springframework.validation.Errors
All known Subclasses: org.springframework.web.bind.EscapedErrors,
Errors | public interface Errors (Code) | | 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
Errors.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 author: Juergen Hoeller See Also: Errors.setNestedPath See Also: BindException See Also: DataBinder See Also: ValidationUtils |
Field Summary | |
String | NESTED_PATH_SEPARATOR The separator between path elements in a nested path,
for example in "customer.name" or "customer.address.street". |
Method Summary | |
void | addAllErrors(Errors errors) Add all errors from the given Errors instance to this
Errors instance. | List | 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 | getFieldErrors() Get all errors associated with a field. | List | 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 | getGlobalErrors() Get all global errors. | String | getNestedPath() Return the current nested path of this
Errors object.
Returns a nested path with a dot, i.e. | String | getObjectName() Return the name of the bound root object. | boolean | hasErrors() Return if there were any errors. | boolean | hasFieldErrors() | boolean | hasFieldErrors(String field) | boolean | hasGlobalErrors() | 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, String defaultMessage) 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 | 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.
The field name may be null or empty String to indicate
the current object itself rather than a field of it. | 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.
The field name may be null or empty String to indicate
the current object itself rather than a field of it. | 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.
The field name may be null or empty String to indicate
the current object itself rather than a field of it. | void | setNestedPath(String nestedPath) Allow context to be changed so that standard validators can validate
subtrees. |
addAllErrors | void addAllErrors(Errors errors)(Code) | | Add all errors from the given 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.
Parameters: errors - the Errors instance to merge in |
getAllErrors | List getAllErrors()(Code) | | Get all errors, both global and field ones.
List of ObjectError instances |
getErrorCount | int getErrorCount()(Code) | | Return the total number of errors.
|
getFieldError | FieldError getFieldError()(Code) | | Get the first error associated with a field, if any.
the field-specific error, or null |
getFieldError | FieldError getFieldError(String field)(Code) | | Get the first error associated with the given field, if any.
Parameters: field - the field name the field-specific error, or null |
getFieldErrorCount | int getFieldErrorCount()(Code) | | Return the number of errors associated with a field.
the number of errors associated with a field See Also: Errors.getGlobalErrorCount() See Also: |
getFieldErrorCount | int getFieldErrorCount(String field)(Code) | | Return the number of errors associated with the given field.
Parameters: field - the field name the number of errors associated with the given field |
getFieldErrors | List getFieldErrors()(Code) | | Get all errors associated with a field.
a List of FieldError instances |
getFieldErrors | List getFieldErrors(String field)(Code) | | 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 a List of FieldError instances |
getFieldType | Class getFieldType(String field)(Code) | | 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 the type of the field, or null if not determinable |
getFieldValue | Object getFieldValue(String field)(Code) | | 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 the current value of the given field |
getGlobalError | ObjectError getGlobalError()(Code) | | Get the first global error, if any.
the global error, or null |
getGlobalErrors | List getGlobalErrors()(Code) | | Get all global errors.
List of ObjectError instances |
getNestedPath | String getNestedPath()(Code) | | Return the current nested path of this
Errors object.
Returns a nested path with a dot, i.e. "address.", for easy
building of concatenated paths. Default is an empty String.
|
getObjectName | String getObjectName()(Code) | | Return the name of the bound root object.
|
hasErrors | boolean hasErrors()(Code) | | Return if there were any errors.
|
hasFieldErrors | boolean hasFieldErrors()(Code) | | Are there any field errors?
true if there are any errors associated with a field See Also: Errors.hasGlobalErrors() See Also: |
hasFieldErrors | boolean hasFieldErrors(String field)(Code) | | Are there any errors associated with the given field?
Parameters: field - the field name true if there were any errors associated with the given field |
hasGlobalErrors | boolean hasGlobalErrors()(Code) | | Are there any global errors?
true if there are any global errors See Also: Errors.hasFieldErrors() See Also: |
pushNestedPath | void pushNestedPath(String subPath)(Code) | | Push the given sub path onto the nested path stack.
A
Errors.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.
Parameters: subPath - the sub path to push onto the nested path stack See Also: Errors.popNestedPath |
reject | void reject(String errorCode)(Code) | | Register a global error for the entire target object,
using the given error description.
Parameters: errorCode - error code, interpretable as a message key |
reject | void reject(String errorCode, String defaultMessage)(Code) | | Register a global error for the entire target object,
using the given error description.
Parameters: errorCode - error code, interpretable as a message key Parameters: defaultMessage - fallback default message |
reject | void reject(String errorCode, Object[] errorArgs, String defaultMessage)(Code) | | Register a global error for the entire target object,
using the given error description.
Parameters: errorCode - error code, interpretable as a message key Parameters: errorArgs - error arguments, for argument binding via MessageFormat(can be null ) Parameters: defaultMessage - fallback default message |
rejectValue | void rejectValue(String field, String errorCode)(Code) | | 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 be null or empty String) Parameters: errorCode - error code, interpretable as a message key See Also: Errors.getNestedPath() |
rejectValue | void rejectValue(String field, String errorCode, String defaultMessage)(Code) | | 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 be null or empty String) Parameters: errorCode - error code, interpretable as a message key Parameters: defaultMessage - fallback default message See Also: Errors.getNestedPath() |
rejectValue | void rejectValue(String field, String errorCode, Object[] errorArgs, String defaultMessage)(Code) | | 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 be null or empty String) Parameters: errorCode - error code, interpretable as a message key Parameters: errorArgs - error arguments, for argument binding via MessageFormat(can be null ) Parameters: defaultMessage - fallback default message See Also: Errors.getNestedPath() |
setNestedPath | void setNestedPath(String nestedPath)(Code) | | 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. |
|
|