Spring Context 6.1.4 · org.springframework.validation.Errors

Modifier and Type	Field and Description
public static final String	NESTED_PATH_SEPARATOR The separator between path elements in a nested path, for example in "customer.name" or "customer.address.street".

Method Summary

Modifier and Type	Method and Description
public default void	addAllErrors(Errors the `Errors` instance to merge in errors) Add all errors from the given `Errors` instance to this `Errors` instance.
public default < the exception type to be thrown T extends Throwable> void	failOnError(Function<String, T> a function mapping the message to the exception, e.g. `IllegalArgumentException::new` or `IllegalStateException::new` messageToException) Throw the mapped exception with a message summarizing the recorded errors.
public default List<ObjectError>	Returns: a list of `ObjectError`/`FieldError` instances getAllErrors() Get all errors, both global and field ones.
public default int	getErrorCount() Determine the total number of errors.
public default FieldError	Returns: the field-specific error, or `null` getFieldError() Get the first error associated with a field, if any.
public default FieldError	Returns: the field-specific error, or `null` getFieldError(String the field name field) Get the first error associated with the given field, if any.
public default int	getFieldErrorCount() Determine the number of errors associated with a field.
public default int	getFieldErrorCount(String the field name field) Determine the number of errors associated with the given field.
public List<FieldError>	Returns: a List of `FieldError` instances getFieldErrors() Get all errors associated with a field.
public default List<FieldError>	Returns: a List of `FieldError` instances getFieldErrors(String the field name field) Get all errors associated with the given field.
public default Class<?>	Returns: the type of the field, or `null` if not determinable getFieldType(String the field name field) Determine the type of the given field, as far as possible.
public Object	Returns: the current value of the given field getFieldValue(String the field name field) Return the current value of the given field, either the current bean property value or a rejected update from the last binding.
public default ObjectError	Returns: the global error, or `null` getGlobalError() Get the first global error, if any.
public default int	getGlobalErrorCount() Determine the number of global errors.
public List<ObjectError>	Returns: a list of `ObjectError` instances getGlobalErrors() Get all global errors.
public default String	getNestedPath() Return the current nested path of this `Errors` object.
public String	getObjectName() Return the name of the bound root object.
public default boolean	hasErrors() Determine if there were any errors.
public default boolean	hasFieldErrors() Determine if there were any errors associated with a field.
public default boolean	hasFieldErrors(String the field name field) Determine if there were any errors associated with the given field.
public default boolean	hasGlobalErrors() Determine if there were any global errors.
public default void	popNestedPath() Pop the former nested path from the nested path stack.
public default void	pushNestedPath(String the sub path to push onto the nested path stack subPath) Push the given sub path onto the nested path stack.
public default void	reject(String error code, interpretable as a message key errorCode) Register a global error for the entire target object, using the given error description.
public default void	reject(String error code, interpretable as a message key errorCode, String fallback default message defaultMessage) Register a global error for the entire target object, using the given error description.
public void	reject(String error code, interpretable as a message key errorCode, Object[] error arguments, for argument binding via MessageFormat (can be `null`) errorArgs, String fallback default message defaultMessage) Register a global error for the entire target object, using the given error description.
public default void	rejectValue(String the field name (may be `null` or empty String) field, String error code, interpretable as a message key 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.
public default void	rejectValue(String the field name (may be `null` or empty String) field, String error code, interpretable as a message key errorCode, String fallback default message 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.
public void	rejectValue(String the field name (may be `null` or empty String) field, String error code, interpretable as a message key errorCode, Object[] error arguments, for argument binding via MessageFormat (can be `null`) errorArgs, String fallback default message 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.
public default void	setNestedPath(String 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. nestedPath) Allow context to be changed so that standard validators can validate subtrees.
public String	toString() Return a summary of the recorded errors, e.g. for inclusion in an exception message.

NESTED_PATH_SEPARATOR	back to summary
public static final String NESTED_PATH_SEPARATOR The separator between path elements in a nested path, for example in "customer.name" or "customer.address.street". "." = same as the `nested property separator` in the beans package.

Method Detail

addAllErrors back to summary

addAllErrors	back to summary
public default void addAllErrors(Errors errors) Add all errors from the given `Errors` instance to this `Errors` instance. This is a convenience 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. The default implementation throws `UnsupportedOperationException` since not all `Errors` implementations support `#addAllErrors`. Parameters errors:Errors the `Errors` instance to merge in See Also `getAllErrors()`

public default void addAllErrors(Errors errors)

Add all errors from the given Errors instance to this Errors instance.

This is a convenience 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.

The default implementation throws UnsupportedOperationException since not all Errors implementations support #addAllErrors.

Parameters

errors:Errors: the Errors instance to merge in

See Also

getAllErrors()

failOnError back to summary

failOnError	back to summary
public default <T extends Throwable> void failOnError(Function<String, T> messageToException) throws Function-:T Throw the mapped exception with a message summarizing the recorded errors. Parameters <T> the exception type to be thrown messageToException:Function<String, T> a function mapping the message to the exception, e.g. `IllegalArgumentException::new` or `IllegalStateException::new` Since 6.1 See Also `toString()`

public default <T extends Throwable> void failOnError(Function<String, T> messageToException) throws Function-:T

Throw the mapped exception with a message summarizing the recorded errors.

Parameters

<T>: the exception type to be thrown
messageToException:Function<String, T>: a function mapping the message to the exception, e.g. IllegalArgumentException::new or IllegalStateException::new

Since

6.1

See Also

toString()

getAllErrors back to summary

getAllErrors	back to summary
public default List<ObjectError> getAllErrors() Get all errors, both global and field ones. Returns:List<ObjectError> a list of `ObjectError`/`FieldError` instances See Also `getGlobalErrors()`, `getFieldErrors()`

public default List<ObjectError> getAllErrors()

Get all errors, both global and field ones.

Returns:List<ObjectError>: a list of ObjectError/FieldError instances
See Also: getGlobalErrors(), getFieldErrors()

getErrorCount back to summary

getErrorCount	back to summary
public default int getErrorCount() Determine the total number of errors. See Also `getGlobalErrorCount()`, `getFieldErrorCount()`

public default int getErrorCount()

Determine the total number of errors.

See Also: getGlobalErrorCount(), getFieldErrorCount()

getFieldError back to summary

getFieldError	back to summary
public default FieldError getFieldError() Get the first error associated with a field, if any. Returns:FieldError the field-specific error, or `null` Annotations @Nullable See Also `getGlobalError()`

public default FieldError getFieldError()

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

Returns:FieldError

the field-specific error, or null

Annotations

@Nullable

See Also

getGlobalError()

getFieldError back to summary

getFieldError	back to summary
public default FieldError getFieldError(String field) Get the first error associated with the given field, if any. Parameters field:String the field name Returns:FieldError the field-specific error, or `null` Annotations @Nullable See Also `getFieldError()`

public default FieldError getFieldError(String field)

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

Parameters

field:String: the field name

Returns:FieldError

the field-specific error, or null

Annotations

@Nullable

See Also

getFieldError()

getFieldErrorCount back to summary

getFieldErrorCount	back to summary
public default int getFieldErrorCount() Determine the number of errors associated with a field. See Also `getGlobalErrorCount()`

public default int getFieldErrorCount()

Determine the number of errors associated with a field.

See Also: getGlobalErrorCount()

getFieldErrorCount back to summary

getFieldErrorCount	back to summary
public default int getFieldErrorCount(String field) Determine the number of errors associated with the given field. Parameters field:String the field name See Also `getFieldErrorCount()`

public default int getFieldErrorCount(String field)

Determine the number of errors associated with the given field.

Parameters

field:String: the field name

See Also

getFieldErrorCount()

getFieldErrors back to summary

getFieldErrors	back to summary
public List<FieldError> getFieldErrors() Get all errors associated with a field. Returns:List<FieldError> a List of `FieldError` instances See Also `getGlobalErrors()`

public List<FieldError> getFieldErrors()

Get all errors associated with a field.

Returns:List<FieldError>: a List of FieldError instances
See Also: getGlobalErrors()

getFieldErrors back to summary

getFieldErrors	back to summary
public default List<FieldError> getFieldErrors(String field) 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.*". Parameters field:String the field name Returns:List<FieldError> a List of `FieldError` instances See Also `getFieldErrors()`

public default List<FieldError> getFieldErrors(String field)

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

Parameters

field:String: the field name

Returns:List<FieldError>

a List of FieldError instances

See Also

getFieldErrors()

getFieldType back to summary

getFieldType	back to summary
public default Class<?> getFieldType(String field) 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. Parameters field:String the field name Returns:Class<?> the type of the field, or `null` if not determinable Annotations @Nullable See Also `getFieldValue(String)`

public default Class<?> getFieldType(String field)

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.

Parameters

field:String: the field name

Returns:Class<?>

the type of the field, or null if not determinable

Annotations

@Nullable

See Also

getFieldValue(String)

getFieldValue back to summary

getFieldValue	back to summary
public 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. Allows for convenient access to user-specified field values, even if there were type mismatches. Parameters field:String the field name Returns:Object the current value of the given field Annotations @Nullable See Also `getFieldType(String)`

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

Allows for convenient access to user-specified field values, even if there were type mismatches.

Parameters

field:String: the field name

Returns:Object

the current value of the given field

Annotations

@Nullable

See Also

getFieldType(String)

getGlobalError back to summary

getGlobalError	back to summary
public default ObjectError getGlobalError() Get the first global error, if any. Returns:ObjectError the global error, or `null` Annotations @Nullable See Also `getFieldError()`

public default ObjectError getGlobalError()

Get the first global error, if any.

Returns:ObjectError

the global error, or null

Annotations

@Nullable

See Also

getFieldError()

getGlobalErrorCount back to summary

getGlobalErrorCount	back to summary
public default int getGlobalErrorCount() Determine the number of global errors. See Also `getFieldErrorCount()`

public default int getGlobalErrorCount()

Determine the number of global errors.

See Also: getFieldErrorCount()

getGlobalErrors back to summary

getGlobalErrors	back to summary
public List<ObjectError> getGlobalErrors() Get all global errors. Returns:List<ObjectError> a list of `ObjectError` instances See Also `getFieldErrors()`

public List<ObjectError> getGlobalErrors()

Get all global errors.

Returns:List<ObjectError>: a list of ObjectError instances
See Also: getFieldErrors()

getNestedPath back to summary

getNestedPath	back to summary
public default 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. See Also `setNestedPath(String)`

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

See Also: setNestedPath(String)

getObjectName	back to summary
public String getObjectName() Return the name of the bound root object.

hasErrors back to summary

hasErrors	back to summary
public default boolean hasErrors() Determine if there were any errors. See Also `hasGlobalErrors()`, `hasFieldErrors()`

public default boolean hasErrors()

Determine if there were any errors.

See Also: hasGlobalErrors(), hasFieldErrors()

hasFieldErrors back to summary

hasFieldErrors	back to summary
public default boolean hasFieldErrors() Determine if there were any errors associated with a field. See Also `hasGlobalErrors()`

public default boolean hasFieldErrors()

Determine if there were any errors associated with a field.

See Also: hasGlobalErrors()

hasFieldErrors back to summary

hasFieldErrors	back to summary
public default boolean hasFieldErrors(String field) Determine if there were any errors associated with the given field. Parameters field:String the field name See Also `hasFieldErrors()`

public default boolean hasFieldErrors(String field)

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

Parameters

field:String: the field name

See Also

hasFieldErrors()

hasGlobalErrors back to summary

hasGlobalErrors	back to summary
public default boolean hasGlobalErrors() Determine if there were any global errors. See Also `hasFieldErrors()`

public default boolean hasGlobalErrors()

Determine if there were any global errors.

See Also: hasFieldErrors()

popNestedPath back to summary

popNestedPath	back to summary
public default void popNestedPath() throws IllegalStateException Pop the former nested path from the nested path stack. Exceptions IllegalStateException: if there is no former nested path on the stack See Also `pushNestedPath(String)`

public default void popNestedPath() throws IllegalStateException

Pop the former nested path from the nested path stack.

Exceptions

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

See Also

pushNestedPath(String)

pushNestedPath back to summary

pushNestedPath	back to summary
public default 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. The default implementation throws `UnsupportedOperationException` since not all `Errors` implementations support nested paths. Parameters subPath:String the sub path to push onto the nested path stack See Also `popNestedPath()`

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

The default implementation throws UnsupportedOperationException since not all Errors implementations support nested paths.

Parameters

subPath:String: the sub path to push onto the nested path stack

See Also

popNestedPath()

reject back to summary

reject	back to summary
public default void reject(String errorCode) Register a global error for the entire target object, using the given error description. Parameters errorCode:String error code, interpretable as a message key See Also `reject(String, Object[], String)`

public default void reject(String errorCode)

Parameters

errorCode:String: error code, interpretable as a message key

See Also

reject(String, Object[], String)

reject back to summary

reject	back to summary
public default void reject(String errorCode, String defaultMessage) Register a global error for the entire target object, using the given error description. Parameters errorCode:String error code, interpretable as a message key defaultMessage:String fallback default message See Also `reject(String, Object[], String)`

public default void reject(String errorCode, String defaultMessage)

Parameters

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

See Also

reject(String, Object[], String)

reject back to summary

reject	back to summary
public void reject(String errorCode, Object[] errorArgs, String defaultMessage) Register a global error for the entire target object, using the given error description. Parameters errorCode:String error code, interpretable as a message key errorArgs:Object[] error arguments, for argument binding via MessageFormat (can be `null`) defaultMessage:String fallback default message See Also `rejectValue(String, String, Object[], String)`

public void reject(String errorCode, Object[] errorArgs, String defaultMessage)

Parameters

errorCode:String: error code, interpretable as a message key
errorArgs:Object[]: error arguments, for argument binding via MessageFormat (can be null)
defaultMessage:String: fallback default message

rejectValue back to summary

rejectValue	back to summary
public default 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:String the field name (may be `null` or empty String) errorCode:String error code, interpretable as a message key See Also `rejectValue(String, String, Object[], String)`

public default 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:String: the field name (may be null or empty String)
errorCode:String: error code, interpretable as a message key

rejectValue back to summary

rejectValue	back to summary
public default 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:String the field name (may be `null` or empty String) errorCode:String error code, interpretable as a message key defaultMessage:String fallback default message See Also `rejectValue(String, String, Object[], String)`

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

Parameters

field:String: the field name (may be null or empty String)
errorCode:String: error code, interpretable as a message key
defaultMessage:String: fallback default message

rejectValue back to summary

rejectValue	back to summary
public 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. 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:String the field name (may be `null` or empty String) errorCode:String error code, interpretable as a message key errorArgs:Object[] error arguments, for argument binding via MessageFormat (can be `null`) defaultMessage:String fallback default message See Also `reject(String, Object[], String)`

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

Parameters

field:String: the field name (may be null or empty String)
errorCode:String: error code, interpretable as a message key
errorArgs:Object[]: error arguments, for argument binding via MessageFormat (can be null)
defaultMessage:String: fallback default message

See Also

reject(String, Object[], String)

setNestedPath back to summary

setNestedPath	back to summary
public default 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. The default implementation throws `UnsupportedOperationException` since not all `Errors` implementations support nested paths. Parameters nestedPath:String 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()`

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

The default implementation throws UnsupportedOperationException since not all Errors implementations support nested paths.

Parameters

nestedPath:String: 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()

toString back to summary

toString	back to summary
public String toString() Return a summary of the recorded errors, e.g. for inclusion in an exception message. See Also `failOnError(Function)`

public String toString()

Return a summary of the recorded errors, e.g. for inclusion in an exception message.

See Also: failOnError(Function)

public Interface Errors

Field Summary

Method Summary

Field Detail

Method Detail