org.springframework.validation

Class AbstractBindingResult

    • Constructor Detail

      • AbstractBindingResult

        protected AbstractBindingResult(java.lang.String objectName)
        Create a new AbstractBindingResult instance.
        Parameters:
        objectName - the name of the target object
        See Also:
        DefaultMessageCodesResolver
    • Method Detail

      • setMessageCodesResolver

        public void setMessageCodesResolver(MessageCodesResolver messageCodesResolver)
        Set the strategy to use for resolving errors into message codes. Default is DefaultMessageCodesResolver.
        See Also:
        DefaultMessageCodesResolver
      • getMessageCodesResolver

        public MessageCodesResolver getMessageCodesResolver()
        Return the strategy to use for resolving errors into message codes.
      • getObjectName

        public java.lang.String getObjectName()
        Description copied from interface: Errors
        Return the name of the bound root object.
        Specified by:
        getObjectName in interface Errors
      • reject

        public void reject(java.lang.String errorCode,
                           @Nullable
                           java.lang.Object[] errorArgs,
                           @Nullable
                           java.lang.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
        errorArgs - error arguments, for argument binding via MessageFormat (can be null)
        defaultMessage - fallback default message
      • rejectValue

        public void rejectValue(@Nullable
                                java.lang.String field,
                                java.lang.String errorCode,
                                @Nullable
                                java.lang.Object[] errorArgs,
                                @Nullable
                                java.lang.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
        errorArgs - error arguments, for argument binding via MessageFormat (can be null)
        defaultMessage - fallback default message
        See Also:
        Errors.getNestedPath()
      • addAllErrors

        public void addAllErrors(Errors errors)
        Description copied from interface: 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.

        Specified by:
        addAllErrors in interface Errors
        Parameters:
        errors - the Errors instance to merge in
      • getFieldErrors

        public java.util.List<FieldError> getFieldErrors()
        Description copied from interface: Errors
        Get all errors associated with a field.
        Specified by:
        getFieldErrors in interface Errors
        Returns:
        a List of FieldError instances
      • getFieldErrors

        public java.util.List<FieldError> getFieldErrors(java.lang.String field)
        Description copied from interface: Errors
        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.*".

        Specified by:
        getFieldErrors in interface Errors
        Overrides:
        getFieldErrors in class AbstractErrors
        Parameters:
        field - the field name
        Returns:
        a List of FieldError instances
      • getFieldError

        @Nullable
        public FieldError getFieldError(java.lang.String field)
        Description copied from interface: Errors
        Get the first error associated with the given field, if any.
        Specified by:
        getFieldError in interface Errors
        Overrides:
        getFieldError in class AbstractErrors
        Parameters:
        field - the field name
        Returns:
        the field-specific error, or null
      • getFieldValue

        @Nullable
        public java.lang.Object getFieldValue(java.lang.String field)
        Description copied from interface: Errors
        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.

        Specified by:
        getFieldValue in interface Errors
        Parameters:
        field - the field name
        Returns:
        the current value of the given field
      • getFieldType

        @Nullable
        public java.lang.Class<?> getFieldType(@Nullable
                                                         java.lang.String field)
        This default implementation determines the type based on the actual field value, if any. Subclasses should override this to determine the type from a descriptor, even for null values.
        Specified by:
        getFieldType in interface Errors
        Overrides:
        getFieldType in class AbstractErrors
        Parameters:
        field - the field name
        Returns:
        the type of the field, or null if not determinable
        See Also:
        getActualFieldValue(java.lang.String)
      • getModel

        public java.util.Map<java.lang.String,java.lang.Object> getModel()
        Return a model Map for the obtained state, exposing an Errors instance as 'MODEL_KEY_PREFIX + objectName' and the object itself.

        Note that the Map is constructed every time you're calling this method. Adding things to the map and then re-calling this method will not work.

        The attributes in the model Map returned by this method are usually included in the ModelAndView for a form view that uses Spring's bind tag, which needs access to the Errors instance.

        Specified by:
        getModel in interface BindingResult
        See Also:
        getObjectName(), BindingResult.MODEL_KEY_PREFIX
      • getRawFieldValue

        @Nullable
        public java.lang.Object getRawFieldValue(java.lang.String field)
        Description copied from interface: BindingResult
        Extract the raw field value for the given field. Typically used for comparison purposes.
        Specified by:
        getRawFieldValue in interface BindingResult
        Parameters:
        field - the field to check
        Returns:
        the current value of the field in its raw form, or null if not known
      • findEditor

        @Nullable
        public java.beans.PropertyEditor findEditor(@Nullable
                                                              java.lang.String field,
                                                              @Nullable
                                                              java.lang.Class<?> valueType)
        This implementation delegates to the PropertyEditorRegistry's editor lookup facility, if available.
        Specified by:
        findEditor in interface BindingResult
        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
      • resolveMessageCodes

        public java.lang.String[] resolveMessageCodes(java.lang.String errorCode)
        Description copied from interface: BindingResult
        Resolve the given error code into message codes.

        Calls the configured MessageCodesResolver with appropriate parameters.

        Specified by:
        resolveMessageCodes in interface BindingResult
        Parameters:
        errorCode - the error code to resolve into message codes
        Returns:
        the resolved message codes
      • resolveMessageCodes

        public java.lang.String[] resolveMessageCodes(java.lang.String errorCode,
                                                      @Nullable
                                                      java.lang.String field)
        Description copied from interface: BindingResult
        Resolve the given error code into message codes for the given field.

        Calls the configured MessageCodesResolver with appropriate parameters.

        Specified by:
        resolveMessageCodes in interface BindingResult
        Parameters:
        errorCode - the error code to resolve into message codes
        field - the field to resolve message codes for
        Returns:
        the resolved message codes
      • recordFieldValue

        public void recordFieldValue(java.lang.String field,
                                     java.lang.Class<?> type,
                                     @Nullable
                                     java.lang.Object value)
        Description copied from interface: BindingResult
        Record the given value for the specified field.

        To be used when a target object cannot be constructed, making the original field values available through Errors.getFieldValue(java.lang.String). In case of a registered error, the rejected value will be exposed for each affected field.

        Specified by:
        recordFieldValue in interface BindingResult
        Parameters:
        field - the field to record the value for
        type - the type of the field
        value - the original value
      • equals

        public boolean equals(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • getTarget

        @Nullable
        public abstract java.lang.Object getTarget()
        Return the wrapped target object.
        Specified by:
        getTarget in interface BindingResult
      • getActualFieldValue

        @Nullable
        protected abstract java.lang.Object getActualFieldValue(java.lang.String field)
        Extract the actual field value for the given field.
        Parameters:
        field - the field to check
        Returns:
        the current value of the field
      • formatFieldValue

        @Nullable
        protected java.lang.Object formatFieldValue(java.lang.String field,
                                                              @Nullable
                                                              java.lang.Object value)
        Format the given value for the specified field.

        The default implementation simply returns the field value as-is.

        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