public abstract class

AbstractErrors

extends Object
implements Serializable Errors
java.lang.Object
   ↳ org.springframework.validation.AbstractErrors
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Abstract implementation of the Errors interface. Provides common access to evaluated errors; however, does not define concrete management of ObjectErrors and FieldErrors.

Summary

[Expand]
Inherited Constants
From interface org.springframework.validation.Errors
Public Constructors
AbstractErrors()
Public Methods
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(String field)
Get the first error associated with the given field, if any.
int getFieldErrorCount(String field)
Return the number of errors associated with the given field.
int getFieldErrorCount()
Return the number of errors associated with a 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.
ObjectError getGlobalError()
Get the first global error, if any.
int getGlobalErrorCount()
Return the number of global errors.
String getNestedPath()
Return the current nested path of this Errors object.
boolean hasErrors()
Return if there were any errors.
boolean hasFieldErrors(String field)
Are there any errors associated with the given field?
boolean hasFieldErrors()
Are there any field errors?
boolean hasGlobalErrors()
Are there any global errors?
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 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 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 setNestedPath(String nestedPath)
Allow context to be changed so that standard validators can validate subtrees.
String toString()
Protected Methods
String canonicalFieldName(String field)
Determine the canonical field name for the given field.
void doSetNestedPath(String nestedPath)
Actually set the nested path.
String fixedField(String field)
Transform the given field into its full path, regarding the nested path of this instance.
boolean isMatchingFieldError(String field, FieldError fieldError)
Check whether the given FieldError matches the given field.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.validation.Errors

Public Constructors

public AbstractErrors ()

Public Methods

public List<ObjectError> getAllErrors ()

Get all errors, both global and field ones.

Returns

public int getErrorCount ()

Return the total number of errors.

public FieldError getFieldError ()

Get the first error associated with a field, if any.

Returns
  • the field-specific error, or null

public FieldError getFieldError (String field)

Get the first error associated with the given field, if any.

Parameters
field the field name
Returns
  • the field-specific error, or null

public int getFieldErrorCount (String field)

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

public int getFieldErrorCount ()

Return the number of errors associated with a field.

Returns
  • the number of errors associated with a field

public List<FieldError> getFieldErrors (String field)

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

public Class getFieldType (String field)

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

public ObjectError getGlobalError ()

Get the first global error, if any.

Returns
  • the global error, or null

public int getGlobalErrorCount ()

Return the number of global errors.

Returns
  • the number of global errors

public String getNestedPath ()

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.

public boolean hasErrors ()

Return if there were any errors.

public boolean hasFieldErrors (String field)

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

public boolean hasFieldErrors ()

Are there any field errors?

Returns
  • true if there are any errors associated with a field

public boolean hasGlobalErrors ()

Are there any global errors?

Returns
  • true if there are any global errors

public void popNestedPath ()

Pop the former nested path from the nested path stack.

Throws
IllegalArgumentException

public void pushNestedPath (String subPath)

Push the given sub path onto the nested path stack.

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.

Parameters
subPath the sub path to push onto the nested path stack

public void reject (String errorCode)

Register a global error for the entire target object, using the given error description.

Parameters
errorCode error code, interpretable as a message key

public void reject (String errorCode, String defaultMessage)

Register a global error for the entire target object, using the given error description.

Parameters
errorCode error code, interpretable as a message key
defaultMessage fallback default message

public 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. 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)
errorCode error code, interpretable as a message key
defaultMessage fallback default message

public 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. 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)
errorCode error code, interpretable as a message key

public void setNestedPath (String nestedPath)

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.

public String toString ()

Protected Methods

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

protected void doSetNestedPath (String nestedPath)

Actually set the nested path. Delegated to by setNestedPath and pushNestedPath.

protected String fixedField (String field)

Transform the given field into its full path, regarding the nested path of this instance.

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 for
fieldError the candidate FieldError
Returns
  • whether the FieldError matches the given field