BeanPropertyBindingResult

Class Overview

Default implementation of the Errors and BindingResult interfaces, for the registration and evaluation of binding errors on JavaBean objects.

Performs standard JavaBean property access, also supporting nested properties. Normally, application code will work with the Errors interface or the BindingResult interface. A DataBinder returns its BindingResult via getBindingResult().

Summary

[Expand] Inherited Constants
From interface org.springframework.validation.Errors String NESTED_PATH_SEPARATOR The separator between path elements in a nested path, for example in "customer.name" or "customer.address.street".

[Expand] Inherited Fields
From interface org.springframework.validation.BindingResult public static final String MODEL_KEY_PREFIX Prefix for the name of the BindingResult instance in a model, followed by the object name.

[Expand] Inherited Methods
From class org.springframework.validation.AbstractPropertyBindingResult String canonicalFieldName(String field) Returns the canonical property name. PropertyEditor findEditor(String field, Class valueType) This implementation exposes a PropertyEditor adapter for a Formatter, if applicable. 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. 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)
From class org.springframework.validation.AbstractBindingResult void addAllErrors(Errors errors) Add all errors from the given Errors instance to this Errors instance. void addError(ObjectError error) Add a custom ObjectError or FieldError to the errors list. boolean equals(Object other) PropertyEditor findEditor(String field, Class valueType) This implementation delegates to the PropertyEditorRegistry's editor lookup facility, if available. Object formatFieldValue(String field, Object value) Format the given value for the specified field. abstract Object getActualFieldValue(String field) Extract the actual field value for the given field. 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. List<FieldError> getFieldErrors() Get all errors associated with a field. List<FieldError> getFieldErrors(String field) Get all errors associated with the given field. Class getFieldType(String field) This default implementation determines the type based on the actual field value, if any. 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. ObjectError getGlobalError() Get the first global error, if any. List<ObjectError> getGlobalErrors() Get all global errors. MessageCodesResolver getMessageCodesResolver() Return the strategy to use for resolving errors into message codes. Map<String, Object> getModel() Return a model Map for the obtained state, exposing an Errors instance as 'MODEL_KEY_PREFIX + objectName' and the object itself. String getObjectName() Return the name of the bound root object. PropertyEditorRegistry getPropertyEditorRegistry() This implementation returns null. Object getRawFieldValue(String field) Extract the raw field value for the given field. String[] getSuppressedFields() Return the list of fields that were suppressed during the bind process. abstract Object getTarget() Return the wrapped target object. boolean hasErrors() Return if there were any errors. int hashCode() void recordSuppressedField(String field) Mark the specified disallowed field as suppressed. void reject(String errorCode, Object[] errorArgs, String defaultMessage) Register a global error for the entire target object, using the given error description. 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. String[] resolveMessageCodes(String errorCode) Resolve the given error code into message codes. String[] resolveMessageCodes(String errorCode, String field) Resolve the given error code into message codes for the given field. void setMessageCodesResolver(MessageCodesResolver messageCodesResolver) Set the strategy to use for resolving errors into message codes.
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 Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.validation.BindingResult abstract void addError(ObjectError error) Add a custom ObjectError or FieldError to the errors list. abstract PropertyEditor findEditor(String field, Class valueType) Find a custom property editor for the given type and property. abstract Map<String, Object> getModel() Return a model Map for the obtained state, exposing a BindingResult instance as 'MODEL_KEY_PREFIX + objectName' and the object itself as 'objectName'. abstract PropertyEditorRegistry getPropertyEditorRegistry() Return the underlying PropertyEditorRegistry. abstract Object getRawFieldValue(String field) Extract the raw field value for the given field. abstract String[] getSuppressedFields() Return the list of fields that were suppressed during the bind process. abstract Object getTarget() Return the wrapped target object, which may be a bean, an object with public fields, a Map - depending on the concrete binding strategy. abstract void recordSuppressedField(String field) Mark the specified disallowed field as suppressed. abstract String[] resolveMessageCodes(String errorCode, String field) Resolve the given error code into message codes for the given field.
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.