public abstract class

AbstractPropertyBindingResult

extends AbstractBindingResult

java.lang.Object
↳	org.springframework.validation.AbstractErrors
	↳	org.springframework.validation.AbstractBindingResult
		↳	org.springframework.validation.AbstractPropertyBindingResult

Known Direct Subclasses

BeanPropertyBindingResult, DirectFieldBindingResult

Class Overview

Abstract base class for BindingResult implementations that work with Spring's PropertyAccessor mechanism. Pre-implements field access through delegation to the corresponding PropertyAccessor methods.

Summary

[Expand]

Inherited Constants

From interface org.springframework.validation.Errors

[Expand]

Inherited Fields

From interface org.springframework.validation.BindingResult

Protected Constructors
	AbstractPropertyBindingResult(String objectName) Create a new AbstractPropertyBindingResult instance.

Public Methods
PropertyEditor	findEditor(String field, Class valueType) This implementation exposes a PropertyEditor adapter for a Formatter, if applicable.
Class	getFieldType(String field) Determines the field type from the property type.
abstract ConfigurablePropertyAccessor	getPropertyAccessor() Provide the PropertyAccessor to work with, according to the concrete strategy of access.
PropertyEditorRegistry	getPropertyEditorRegistry() Returns the underlying PropertyAccessor.
void	initConversion(ConversionService conversionService)

Protected Methods
String	canonicalFieldName(String field) Returns the canonical property name.
Object	formatFieldValue(String field, Object value) Formats the field value based on registered PropertyEditors.
Object	getActualFieldValue(String field) Fetches the field value from the PropertyAccessor.
PropertyEditor	getCustomEditor(String fixedField) Retrieve the custom PropertyEditor for the given field, if any.

[Expand]

Inherited Methods

From class org.springframework.validation.AbstractBindingResult

From class org.springframework.validation.AbstractErrors

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.
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?
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, 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()

From class java.lang.Object

From interface org.springframework.validation.BindingResult

From interface org.springframework.validation.Errors

abstract void	addAllErrors(Errors errors) Add all errors from the given `Errors` instance to this `Errors` instance.
abstract List<ObjectError>	getAllErrors() Get all errors, both global and field ones.
abstract int	getErrorCount() Return the total number of errors.
abstract FieldError	getFieldError() Get the first error associated with a field, if any.
abstract FieldError	getFieldError(String field) Get the first error associated with the given field, if any.
abstract int	getFieldErrorCount(String field) Return the number of errors associated with the given field.
abstract int	getFieldErrorCount() Return the number of errors associated with a field.
abstract List<FieldError>	getFieldErrors() Get all errors associated with a field.
abstract List<FieldError>	getFieldErrors(String field) Get all errors associated with the given field.
abstract Class	getFieldType(String field) Return the type of a given field.
abstract 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.
abstract ObjectError	getGlobalError() Get the first global error, if any.
abstract int	getGlobalErrorCount() Return the number of global errors.
abstract List<ObjectError>	getGlobalErrors() Get all global errors.
abstract String	getNestedPath() Return the current nested path of this `Errors` object.
abstract String	getObjectName() Return the name of the bound root object.
abstract boolean	hasErrors() Return if there were any errors.
abstract boolean	hasFieldErrors(String field) Are there any errors associated with the given field?
abstract boolean	hasFieldErrors() Are there any field errors?
abstract boolean	hasGlobalErrors() Are there any global errors?
abstract void	popNestedPath() Pop the former nested path from the nested path stack.
abstract void	pushNestedPath(String subPath) Push the given sub path onto the nested path stack.
abstract void	reject(String errorCode) Register a global error for the entire target object, using the given error description.
abstract void	reject(String errorCode, Object[] errorArgs, String defaultMessage) Register a global error for the entire target object, using the given error description.
abstract void	reject(String errorCode, String defaultMessage) Register a global error for the entire target object, using the given error description.
abstract 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.
abstract 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.
abstract 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.
abstract void	setNestedPath(String nestedPath) Allow context to be changed so that standard validators can validate subtrees.

Protected Constructors

protected AbstractPropertyBindingResult (String objectName)

Create a new AbstractPropertyBindingResult instance.

Parameters

objectName	the name of the target object

Public Methods

public PropertyEditor findEditor (String field, Class valueType)

This implementation exposes a PropertyEditor adapter for a Formatter, if applicable.

Parameters

field	the path of the property (name or nested path), or `null` if looking for an editor for all properties of the given type
valueType	the type of the property (can be `null` if a property is given but should be specified in any case for consistency checking)

Returns

the registered editor, or null if none

public Class getFieldType (String field)

Determines the field type from the property type.

Parameters

field	the field name

Returns

the type of the field, or null if not determinable

public abstract ConfigurablePropertyAccessor getPropertyAccessor ()

Provide the PropertyAccessor to work with, according to the concrete strategy of access.

Note that a PropertyAccessor used by a BindingResult should always have its "extractOldValueForEditor" flag set to "true" by default, since this is typically possible without side effects for model objects that serve as data binding target.

public PropertyEditorRegistry getPropertyEditorRegistry ()

Returns the underlying PropertyAccessor.

Returns

the PropertyEditorRegistry, or null if none available for this BindingResult

public void initConversion (ConversionService conversionService)

Protected Methods

protected String canonicalFieldName (String field)

Returns the canonical property name.

Parameters

field	the original field name

Returns

the canonical field name

protected Object formatFieldValue (String field, Object value)

Formats the field value based on registered PropertyEditors.

Parameters

field	the field to check
value	the value of the field (either a rejected value other than from a binding error, or an actual field value)

Returns

the formatted value

protected Object getActualFieldValue (String field)

Fetches the field value from the PropertyAccessor.

Parameters

field	the field to check

Returns

the current value of the field

protected PropertyEditor getCustomEditor (String fixedField)

Retrieve the custom PropertyEditor for the given field, if any.

Parameters

fixedField	the fully qualified field name

Returns

the custom PropertyEditor, or null

Interfaces

Classes

Exceptions

AbstractPropertyBindingResult

Class Overview

See Also

Summary

Protected Constructors

protected AbstractPropertyBindingResult (String objectName)

Parameters

See Also

Public Methods

public PropertyEditor findEditor (String field, Class valueType)

Parameters

Returns

public Class getFieldType (String field)

Parameters

Returns

See Also

public abstract ConfigurablePropertyAccessor getPropertyAccessor ()

See Also

public PropertyEditorRegistry getPropertyEditorRegistry ()

Returns

See Also

public void initConversion (ConversionService conversionService)

Protected Methods

protected String canonicalFieldName (String field)

Parameters

Returns

See Also

protected Object formatFieldValue (String field, Object value)

Parameters

Returns

See Also

protected Object getActualFieldValue (String field)

Parameters

Returns

See Also

protected PropertyEditor getCustomEditor (String fixedField)

Parameters

Returns