Class AbstractErrors
- java.lang.Object
- org.springframework.validation.AbstractErrors
- All Implemented Interfaces:
Serializable,Errors
- Direct Known Subclasses:
AbstractBindingResult
public abstract class AbstractErrors extends Object implements Errors, Serializable
Abstract implementation of theErrorsinterface. Provides common access to evaluated errors; however, does not define concrete management ofObjectErrorsandFieldErrors.- Since:
- 2.5.3
- Author:
- Juergen Hoeller, Rossen Stoyanchev
- See Also:
- Serialized Form
Field Summary
Fields inherited from interface org.springframework.validation.Errors
NESTED_PATH_SEPARATOR
Constructor Summary
Constructors Constructor Description AbstractErrors()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected StringcanonicalFieldName(String field)Determine the canonical field name for the given field.protected voiddoSetNestedPath(String nestedPath)Actually set the nested path.protected StringfixedField(String field)Transform the given field into its full path, regarding the nested path of this instance.List<ObjectError>getAllErrors()Get all errors, both global and field ones.intgetErrorCount()Return the total number of errors.FieldErrorgetFieldError()Get the first error associated with a field, if any.FieldErrorgetFieldError(String field)Get the first error associated with the given field, if any.intgetFieldErrorCount()Return the number of errors associated with a field.intgetFieldErrorCount(String field)Return the number of errors associated with the given 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.ObjectErrorgetGlobalError()Get the first global error, if any.intgetGlobalErrorCount()Return the number of global errors.StringgetNestedPath()Return the current nested path of thisErrorsobject.booleanhasErrors()Return if there were any errors.booleanhasFieldErrors()Are there any field errors?booleanhasFieldErrors(String field)Are there any errors associated with the given field?booleanhasGlobalErrors()Are there any global errors?protected booleanisMatchingFieldError(String field, FieldError fieldError)Check whether the given FieldError matches the given field.voidpopNestedPath()Pop the former nested path from the nested path stack.voidpushNestedPath(String subPath)Push the given sub path onto the nested path stack.voidreject(String errorCode)Register a global error for the entire target object, using the given error description.voidreject(String errorCode, String defaultMessage)Register a global error for the entire target object, using the given error description.voidrejectValue(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.voidrejectValue(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.voidsetNestedPath(String nestedPath)Allow context to be changed so that standard validators can validate subtrees.StringtoString()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 Detail
AbstractErrors
public AbstractErrors()
Method Detail
setNestedPath
public void setNestedPath(@Nullable String nestedPath)
Description copied from interface:ErrorsAllow 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:
setNestedPathin interfaceErrors- Parameters:
nestedPath- nested path within this object, e.g. "address" (defaults to "",nullis also acceptable). Can end with a dot: both "address" and "address." are valid.
getNestedPath
public String getNestedPath()
Description copied from interface:ErrorsReturn the current nested path of thisErrorsobject.Returns a nested path with a dot, i.e. "address.", for easy building of concatenated paths. Default is an empty String.
- Specified by:
getNestedPathin interfaceErrors
pushNestedPath
public void pushNestedPath(String subPath)
Description copied from interface:ErrorsPush 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:
pushNestedPathin interfaceErrors- Parameters:
subPath- the sub path to push onto the nested path stack- See Also:
Errors.popNestedPath()
popNestedPath
public void popNestedPath() throws IllegalStateException
Description copied from interface:ErrorsPop the former nested path from the nested path stack.- Specified by:
popNestedPathin interfaceErrors- Throws:
IllegalStateException- if there is no former nested path on the stack- See Also:
Errors.pushNestedPath(java.lang.String)
doSetNestedPath
protected void doSetNestedPath(@Nullable String nestedPath)
Actually set the nested path. Delegated to by setNestedPath and pushNestedPath.
fixedField
protected String fixedField(@Nullable String field)
Transform the given field into its full path, regarding the nested path of this instance.
canonicalFieldName
protected String canonicalFieldName(String field)
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
public void reject(String errorCode)
Description copied from interface:ErrorsRegister a global error for the entire target object, using the given error description.
reject
public void reject(String errorCode, String defaultMessage)
Description copied from interface:ErrorsRegister a global error for the entire target object, using the given error description.
rejectValue
public void rejectValue(@Nullable String field, String errorCode)
Description copied from interface:ErrorsRegister 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
nullor 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:
rejectValuein interfaceErrors- Parameters:
field- the field name (may benullor empty String)errorCode- error code, interpretable as a message key- See Also:
Errors.getNestedPath()
rejectValue
public void rejectValue(@Nullable String field, String errorCode, String defaultMessage)
Description copied from interface:ErrorsRegister 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
nullor 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:
rejectValuein interfaceErrors- Parameters:
field- the field name (may benullor empty String)errorCode- error code, interpretable as a message keydefaultMessage- fallback default message- See Also:
Errors.getNestedPath()
hasErrors
public boolean hasErrors()
Description copied from interface:ErrorsReturn if there were any errors.
getErrorCount
public int getErrorCount()
Description copied from interface:ErrorsReturn the total number of errors.- Specified by:
getErrorCountin interfaceErrors
getAllErrors
public List<ObjectError> getAllErrors()
Description copied from interface:ErrorsGet all errors, both global and field ones.- Specified by:
getAllErrorsin interfaceErrors- Returns:
- a list of
ObjectErrorinstances
hasGlobalErrors
public boolean hasGlobalErrors()
Description copied from interface:ErrorsAre there any global errors?- Specified by:
hasGlobalErrorsin interfaceErrors- Returns:
trueif there are any global errors- See Also:
Errors.hasFieldErrors()
getGlobalErrorCount
public int getGlobalErrorCount()
Description copied from interface:ErrorsReturn the number of global errors.- Specified by:
getGlobalErrorCountin interfaceErrors- Returns:
- the number of global errors
- See Also:
Errors.getFieldErrorCount()
getGlobalError
@Nullable public ObjectError getGlobalError()
Description copied from interface:ErrorsGet the first global error, if any.- Specified by:
getGlobalErrorin interfaceErrors- Returns:
- the global error, or
null
hasFieldErrors
public boolean hasFieldErrors()
Description copied from interface:ErrorsAre there any field errors?- Specified by:
hasFieldErrorsin interfaceErrors- Returns:
trueif there are any errors associated with a field- See Also:
Errors.hasGlobalErrors()
getFieldErrorCount
public int getFieldErrorCount()
Description copied from interface:ErrorsReturn the number of errors associated with a field.- Specified by:
getFieldErrorCountin interfaceErrors- Returns:
- the number of errors associated with a field
- See Also:
Errors.getGlobalErrorCount()
getFieldError
@Nullable public FieldError getFieldError()
Description copied from interface:ErrorsGet the first error associated with a field, if any.- Specified by:
getFieldErrorin interfaceErrors- Returns:
- the field-specific error, or
null
hasFieldErrors
public boolean hasFieldErrors(String field)
Description copied from interface:ErrorsAre there any errors associated with the given field?- Specified by:
hasFieldErrorsin interfaceErrors- Parameters:
field- the field name- Returns:
trueif there were any errors associated with the given field
getFieldErrorCount
public int getFieldErrorCount(String field)
Description copied from interface:ErrorsReturn the number of errors associated with the given field.- Specified by:
getFieldErrorCountin interfaceErrors- Parameters:
field- the field name- Returns:
- the number of errors associated with the given field
getFieldErrors
public List<FieldError> getFieldErrors(String field)
Description copied from interface:ErrorsGet 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.*".
- Specified by:
getFieldErrorsin interfaceErrors- Parameters:
field- the field name- Returns:
- a List of
FieldErrorinstances
getFieldError
@Nullable public FieldError getFieldError(String field)
Description copied from interface:ErrorsGet the first error associated with the given field, if any.- Specified by:
getFieldErrorin interfaceErrors- Parameters:
field- the field name- Returns:
- the field-specific error, or
null
getFieldType
@Nullable public Class<?> getFieldType(String field)
Description copied from interface:ErrorsReturn 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.- Specified by:
getFieldTypein interfaceErrors- Parameters:
field- the field name- Returns:
- the type of the field, or
nullif not determinable
isMatchingFieldError
protected boolean isMatchingFieldError(String field, FieldError fieldError)
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