Class AbstractErrors
- All Implemented Interfaces:
Serializable
,Errors
- Direct Known Subclasses:
AbstractBindingResult
Errors
interface.
Provides nested path handling but does not define concrete management
of ObjectErrors
and FieldErrors
.- Since:
- 2.5.3
- Author:
- Juergen Hoeller, Rossen Stoyanchev
- See Also:
-
Field Summary
Fields inherited from interface org.springframework.validation.Errors
NESTED_PATH_SEPARATOR
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected String
canonicalFieldName
(String field) Determine the canonical field name for the given field.protected void
doSetNestedPath
(String nestedPath) Actually set the nested path.protected String
fixedField
(String field) Transform the given field into its full path, regarding the nested path of this instance.Get all errors, both global and field ones.int
Determine 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
Determine the number of errors associated with a field.int
getFieldErrorCount
(String field) Determine the number of errors associated with the given field.getFieldErrors
(String field) Get all errors associated with the given field.Class<?>
getFieldType
(String field) Determine the type of the given field, as far as possible.Get the first global error, if any.int
Determine the number of global errors.Return the current nested path of thisErrors
object.boolean
Determine if there were any errors.boolean
Determine if there were any errors associated with a field.boolean
hasFieldErrors
(String field) Determine if there were any errors associated with the given field.boolean
Determine if there were any global errors.protected boolean
isMatchingFieldError
(String field, FieldError fieldError) Check whether the given FieldError matches the given field.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
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, 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.toString()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.springframework.validation.Errors
addAllErrors, getFieldErrors, getFieldValue, getGlobalErrors, getObjectName, reject, rejectValue
-
Constructor Details
-
AbstractErrors
public AbstractErrors()
-
-
Method Details
-
setNestedPath
Description copied from interface:Errors
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.
- Specified by:
setNestedPath
in interfaceErrors
- 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.- See Also:
-
getNestedPath
Description copied from interface:Errors
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.
- Specified by:
getNestedPath
in interfaceErrors
- See Also:
-
pushNestedPath
Description copied from interface:Errors
Push the given sub path onto the nested path stack.A
Errors.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.
- Specified by:
pushNestedPath
in interfaceErrors
- Parameters:
subPath
- the sub path to push onto the nested path stack- See Also:
-
popNestedPath
Description copied from interface:Errors
Pop the former nested path from the nested path stack.- Specified by:
popNestedPath
in interfaceErrors
- Throws:
IllegalStateException
- if there is no former nested path on the stack- See Also:
-
doSetNestedPath
Actually set the nested path. Delegated to by setNestedPath and pushNestedPath. -
fixedField
Transform the given field into its full path, regarding the nested path of this instance. -
canonicalFieldName
Determine the canonical field name for the given field.The default implementation simply returns the field name as-is.
- Parameters:
field
- the original field name- Returns:
- the canonical field name
-
reject
Description copied from interface:Errors
Register a global error for the entire target object, using the given error description. -
reject
Description copied from interface:Errors
Register a global error for the entire target object, using the given error description. -
rejectValue
Description copied from interface:Errors
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.- Specified by:
rejectValue
in interfaceErrors
- Parameters:
field
- the field name (may benull
or empty String)errorCode
- error code, interpretable as a message key- See Also:
-
rejectValue
Description copied from interface:Errors
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.- Specified by:
rejectValue
in interfaceErrors
- Parameters:
field
- the field name (may benull
or empty String)errorCode
- error code, interpretable as a message keydefaultMessage
- fallback default message- See Also:
-
hasErrors
public boolean hasErrors()Description copied from interface:Errors
Determine if there were any errors. -
getErrorCount
public int getErrorCount()Description copied from interface:Errors
Determine the total number of errors.- Specified by:
getErrorCount
in interfaceErrors
- See Also:
-
getAllErrors
Description copied from interface:Errors
Get all errors, both global and field ones.- Specified by:
getAllErrors
in interfaceErrors
- Returns:
- a list of
ObjectError
/FieldError
instances - See Also:
-
hasGlobalErrors
public boolean hasGlobalErrors()Description copied from interface:Errors
Determine if there were any global errors.- Specified by:
hasGlobalErrors
in interfaceErrors
- See Also:
-
getGlobalErrorCount
public int getGlobalErrorCount()Description copied from interface:Errors
Determine the number of global errors.- Specified by:
getGlobalErrorCount
in interfaceErrors
- See Also:
-
getGlobalError
Description copied from interface:Errors
Get the first global error, if any.- Specified by:
getGlobalError
in interfaceErrors
- Returns:
- the global error, or
null
- See Also:
-
hasFieldErrors
public boolean hasFieldErrors()Description copied from interface:Errors
Determine if there were any errors associated with a field.- Specified by:
hasFieldErrors
in interfaceErrors
- See Also:
-
getFieldErrorCount
public int getFieldErrorCount()Description copied from interface:Errors
Determine the number of errors associated with a field.- Specified by:
getFieldErrorCount
in interfaceErrors
- See Also:
-
getFieldError
Description copied from interface:Errors
Get the first error associated with a field, if any.- Specified by:
getFieldError
in interfaceErrors
- Returns:
- the field-specific error, or
null
- See Also:
-
hasFieldErrors
Description copied from interface:Errors
Determine if there were any errors associated with the given field.- Specified by:
hasFieldErrors
in interfaceErrors
- Parameters:
field
- the field name- See Also:
-
getFieldErrorCount
Description copied from interface:Errors
Determine the number of errors associated with the given field.- Specified by:
getFieldErrorCount
in interfaceErrors
- Parameters:
field
- the field name- See Also:
-
getFieldErrors
Description copied from interface:Errors
Get all errors associated with the given field.Implementations may support not only full field names like "address.street" but also pattern matches like "address.*".
- Specified by:
getFieldErrors
in interfaceErrors
- Parameters:
field
- the field name- Returns:
- a List of
FieldError
instances - See Also:
-
getFieldError
Description copied from interface:Errors
Get the first error associated with the given field, if any.- Specified by:
getFieldError
in interfaceErrors
- Parameters:
field
- the field name- Returns:
- the field-specific error, or
null
- See Also:
-
getFieldType
Description copied from interface:Errors
Determine the type of the given field, as far as possible.Implementations should be able to determine the type even when the field value is
null
, for example from some associated descriptor.- Specified by:
getFieldType
in interfaceErrors
- Parameters:
field
- the field name- Returns:
- the type of the field, or
null
if not determinable - See Also:
-
isMatchingFieldError
Check whether the given FieldError matches the given field.- Parameters:
field
- the field that we are looking up FieldErrors forfieldError
- the candidate FieldError- Returns:
- whether the FieldError matches the given field
-
toString
-