org.springframework.validation

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 the 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:

AbstractBindingResult, Serialized Form

Field Summary

Fields inherited from interface org.springframework.validation.Errors

NESTED_PATH_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
AbstractErrors()

Method Summary

Modifier and Type	Method and Description
protected 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.
List<ObjectError>	getAllErrors() Get all errors, both global and field ones.
int	getErrorCount() Determine 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() Determine the number of errors associated with a field.
int	getFieldErrorCount(String field) Determine 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) Determine the type of the given field, as far as possible.
ObjectError	getGlobalError() Get the first global error, if any.
int	getGlobalErrorCount() Determine the number of global errors.
String	getNestedPath() Return the current nested path of this Errors object.
boolean	hasErrors() Determine if there were any errors.
boolean	hasFieldErrors() 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	hasGlobalErrors() Determine if there were any global errors.
protected boolean	isMatchingFieldError(String field, FieldError fieldError) Check whether the given FieldError matches the given field.
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) 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.
String	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 Detail

AbstractErrors

public AbstractErrors()

Method Detail

setNestedPath

public void setNestedPath(@Nullable
                          String nestedPath)

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 interface Errors

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:

Errors.getNestedPath()

getNestedPath

public String getNestedPath()

Description copied from interface: Errors

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.

Specified by:

getNestedPath in interface Errors

See Also:

Errors.setNestedPath(String)

pushNestedPath

public void pushNestedPath(String subPath)

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 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.

Specified by:

pushNestedPath in interface Errors

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: Errors

Pop the former nested path from the nested path stack.

Specified by:

popNestedPath in interface Errors

Throws:

IllegalStateException - if there is no former nested path on the stack

See Also:

Errors.pushNestedPath(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: Errors

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

Specified by:

reject in interface Errors

Parameters:

errorCode - error code, interpretable as a message key

See Also:

Errors.reject(String, Object[], String)

reject

public void reject(String errorCode,
                   String defaultMessage)

Description copied from interface: Errors

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

Specified by:

reject in interface Errors

Parameters:

errorCode - error code, interpretable as a message key

defaultMessage - fallback default message

See Also:

Errors.reject(String, Object[], String)

rejectValue

public void rejectValue(@Nullable
                        String field,
                        String errorCode)

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 interface Errors

Parameters:

field - the field name (may be null or empty String)

errorCode - error code, interpretable as a message key

See Also:

Errors.rejectValue(String, String, Object[], String)

rejectValue

public void rejectValue(@Nullable
                        String field,
                        String errorCode,
                        String defaultMessage)

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 interface Errors

Parameters:

field - the field name (may be null or empty String)

errorCode - error code, interpretable as a message key

defaultMessage - fallback default message

See Also:

Errors.rejectValue(String, String, Object[], String)

hasErrors

public boolean hasErrors()

Description copied from interface: Errors

Determine if there were any errors.

Specified by:

hasErrors in interface Errors

See Also:

Errors.hasGlobalErrors(), Errors.hasFieldErrors()

getErrorCount

public int getErrorCount()

Description copied from interface: Errors

Determine the total number of errors.

Specified by:

getErrorCount in interface Errors

See Also:

Errors.getGlobalErrorCount(), Errors.getFieldErrorCount()

getAllErrors

public List<ObjectError> getAllErrors()

Description copied from interface: Errors

Get all errors, both global and field ones.

Specified by:

getAllErrors in interface Errors

Returns:

a list of ObjectError/FieldError instances

See Also:

Errors.getGlobalErrors(), Errors.getFieldErrors()

hasGlobalErrors

public boolean hasGlobalErrors()

Description copied from interface: Errors

Determine if there were any global errors.

Specified by:

hasGlobalErrors in interface Errors

See Also:

Errors.hasFieldErrors()

getGlobalErrorCount

public int getGlobalErrorCount()

Description copied from interface: Errors

Determine the number of global errors.

Specified by:

getGlobalErrorCount in interface Errors

See Also:

Errors.getFieldErrorCount()

getGlobalError

@Nullable
public ObjectError getGlobalError()

Description copied from interface: Errors

Get the first global error, if any.

Specified by:

getGlobalError in interface Errors

Returns:

the global error, or null

See Also:

Errors.getFieldError()

hasFieldErrors

public boolean hasFieldErrors()

Description copied from interface: Errors

Determine if there were any errors associated with a field.

Specified by:

hasFieldErrors in interface Errors

See Also:

Errors.hasGlobalErrors()

getFieldErrorCount

public int getFieldErrorCount()

Description copied from interface: Errors

Determine the number of errors associated with a field.

Specified by:

getFieldErrorCount in interface Errors

See Also:

Errors.getGlobalErrorCount()

getFieldError

@Nullable
public FieldError getFieldError()

Description copied from interface: Errors

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

Specified by:

getFieldError in interface Errors

Returns:

the field-specific error, or null

See Also:

Errors.getGlobalError()

hasFieldErrors

public boolean hasFieldErrors(String field)

Description copied from interface: Errors

Determine if there were any errors associated with the given field.

Specified by:

hasFieldErrors in interface Errors

Parameters:

field - the field name

See Also:

Errors.hasFieldErrors()

getFieldErrorCount

public int getFieldErrorCount(String field)

Description copied from interface: Errors

Determine the number of errors associated with the given field.

Specified by:

getFieldErrorCount in interface Errors

Parameters:

field - the field name

See Also:

Errors.getFieldErrorCount()

getFieldErrors

public List<FieldError> getFieldErrors(String field)

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 interface Errors

Parameters:

field - the field name

Returns:

a List of FieldError instances

See Also:

Errors.getFieldErrors()

getFieldError

@Nullable
public FieldError getFieldError(String field)

Description copied from interface: Errors

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

Specified by:

getFieldError in interface Errors

Parameters:

field - the field name

Returns:

the field-specific error, or null

See Also:

Errors.getFieldError()

getFieldType

@Nullable
public Class<?> getFieldType(String field)

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 interface Errors

Parameters:

field - the field name

Returns:

the type of the field, or null if not determinable

See Also:

Errors.getFieldValue(String)

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 for

fieldError - the candidate FieldError

Returns:

whether the FieldError matches the given field

toString

public String toString()

Overrides:

toString in class Object