接口 Errors

    • 方法详细资料

      • setNestedPath

        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.

        参数:
        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.
      • getNestedPath

        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.

      • pushNestedPath

        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.

        参数:
        subPath - the sub path to push onto the nested path stack
        另请参阅:
        popNestedPath()
      • reject

        void reject​(String errorCode)
        Register a global error for the entire target object, using the given error description.
        参数:
        errorCode - error code, interpretable as a message key
      • reject

        void reject​(String errorCode,
                    String defaultMessage)
        Register a global error for the entire target object, using the given error description.
        参数:
        errorCode - error code, interpretable as a message key
        defaultMessage - fallback default message
      • reject

        void reject​(String errorCode,
                    Object[] errorArgs,
                    String defaultMessage)
        Register a global error for the entire target object, using the given error description.
        参数:
        errorCode - error code, interpretable as a message key
        errorArgs - error arguments, for argument binding via MessageFormat (can be null)
        defaultMessage - fallback default message
      • rejectValue

        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.

        参数:
        field - the field name (may be null or empty String)
        errorCode - error code, interpretable as a message key
        另请参阅:
        getNestedPath()
      • rejectValue

        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.

        参数:
        field - the field name (may be null or empty String)
        errorCode - error code, interpretable as a message key
        defaultMessage - fallback default message
        另请参阅:
        getNestedPath()
      • rejectValue

        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.

        参数:
        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
        另请参阅:
        getNestedPath()
      • addAllErrors

        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.

        参数:
        errors - the Errors instance to merge in
      • hasErrors

        boolean hasErrors()
        Return if there were any errors.
      • getErrorCount

        int getErrorCount()
        Return the total number of errors.
      • hasFieldErrors

        boolean hasFieldErrors()
        Are there any field errors?
        返回:
        true if there are any errors associated with a field
        另请参阅:
        hasGlobalErrors()
      • getFieldError

        FieldError getFieldError()
        Get the first error associated with a field, if any.
        返回:
        the field-specific error, or null
      • hasFieldErrors

        boolean hasFieldErrors​(String field)
        Are there any errors associated with the given field?
        参数:
        field - the field name
        返回:
        true if there were any errors associated with the given field
      • getFieldErrorCount

        int getFieldErrorCount​(String field)
        Return the number of errors associated with the given field.
        参数:
        field - the field name
        返回:
        the number of errors associated with the given field
      • getFieldErrors

        List<FieldErrorgetFieldErrors​(String field)
        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.*".

        参数:
        field - the field name
        返回:
        a List of FieldError instances
      • getFieldError

        FieldError getFieldError​(String field)
        Get the first error associated with the given field, if any.
        参数:
        field - the field name
        返回:
        the field-specific error, or null
      • getFieldValue

        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.

        参数:
        field - the field name
        返回:
        the current value of the given field
      • getFieldType

        Class<?> getFieldType​(String field)
        Return the type of a given field.

        Implementations should be able to determine the type even when the field value is null, for example from some associated descriptor.

        参数:
        field - the field name
        返回:
        the type of the field, or null if not determinable