Class EscapedErrors

java.lang.Object
org.springframework.web.bind.EscapedErrors
All Implemented Interfaces:
Errors
public class EscapedErrors extends Object implements Errors
Errors wrapper that adds automatic HTML escaping to the wrapped instance, for convenient usage in HTML views. Can be retrieved easily via RequestContext's getErrors method.

Note that BindTag does not use this class to avoid unnecessary creation of ObjectError instances. It just escapes the messages and values that get copied into the respective BindStatus instance.

Since:
01.03.2003
Author:
Juergen Hoeller
See Also:

  • Constructor Details

    • EscapedErrors

      public EscapedErrors(Errors source)
      Create a new EscapedErrors instance for the given source instance.

  • Method Details

    • getSource

      public Errors getSource()

    • getObjectName

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

    • setNestedPath

      public void setNestedPath(String nestedPath)
      Description copied from interface: Errors
      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.

      Specified by:
      setNestedPath in interface Errors
      Parameters:
      nestedPath - nested path within this object, for example, "address" (defaults to "", null is also acceptable). Can end with a dot: both "address" and "address." are valid.
      See Also:

    • getNestedPath

      public String getNestedPath()
      Description copied from interface: Errors
      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.

      Specified by:
      getNestedPath in interface Errors
      See Also:

    • pushNestedPath

      public void pushNestedPath(String subPath)
      Description copied from interface: Errors
      Push the given sub path onto the nested path stack.

      A Errors.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.

      Specified by:
      pushNestedPath in interface Errors
      Parameters:
      subPath - the sub path to push onto the nested path stack
      See Also:

    • popNestedPath

      public void popNestedPath() throws IllegalStateException
      Description copied from interface: Errors
      Pop the former nested path from the nested path stack.
      Specified by:
      popNestedPath in interface Errors
      Throws:
      IllegalStateException - if there is no former nested path on the stack
      See Also:

    • reject

      public void reject(String errorCode)
      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
      See Also:

    • reject

      public void reject(String errorCode, 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
      defaultMessage - fallback default message
      See Also:

    • reject

      public void reject(String errorCode, Object @Nullable [] errorArgs, @Nullable 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
      See Also:

    • rejectValue

      public void rejectValue(@Nullable String field, String errorCode)
      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
      See Also:

    • rejectValue

      public void rejectValue(@Nullable String field, String errorCode, 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
      defaultMessage - fallback default message
      See Also:

    • rejectValue

      public void rejectValue(@Nullable String field, String errorCode, Object @Nullable [] errorArgs, @Nullable 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:

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

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

      Specified by:
      addAllErrors in interface Errors
      Parameters:
      errors - the Errors instance to merge in
      See Also:

    • hasErrors

      public boolean hasErrors()
      Description copied from interface: Errors
      Determine if there were any errors.
      Specified by:
      hasErrors in interface Errors
      See Also:

    • getErrorCount

      public int getErrorCount()
      Description copied from interface: Errors
      Determine the total number of errors.
      Specified by:
      getErrorCount in interface Errors
      See Also:

    • getAllErrors

      public List<ObjectError> getAllErrors()
      Description copied from interface: Errors
      Get all errors, both global and field ones.
      Specified by:
      getAllErrors in interface Errors
      Returns:
      a list of ObjectError/FieldError instances
      See Also:

    • hasGlobalErrors

      public boolean hasGlobalErrors()
      Description copied from interface: Errors
      Determine if there were any global errors.
      Specified by:
      hasGlobalErrors in interface Errors
      See Also:

    • getGlobalErrorCount

      public int getGlobalErrorCount()
      Description copied from interface: Errors
      Determine the number of global errors.
      Specified by:
      getGlobalErrorCount in interface Errors
      See Also:

    • getGlobalErrors

      public List<ObjectError> getGlobalErrors()
      Description copied from interface: Errors
      Get all global errors.
      Specified by:
      getGlobalErrors in interface Errors
      Returns:
      a list of ObjectError instances
      See Also:

    • getGlobalError

      public @Nullable ObjectError getGlobalError()
      Description copied from interface: Errors
      Get the first global error, if any.
      Specified by:
      getGlobalError in interface Errors
      Returns:
      the global error, or null
      See Also:

    • hasFieldErrors

      public boolean hasFieldErrors()
      Description copied from interface: Errors
      Determine if there were any errors associated with a field.
      Specified by:
      hasFieldErrors in interface Errors
      See Also:

    • getFieldErrorCount

      public int getFieldErrorCount()
      Description copied from interface: Errors
      Determine the number of errors associated with a field.
      Specified by:
      getFieldErrorCount in interface Errors
      See Also:

    • getFieldErrors

      public 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
      See Also:

    • getFieldError

      public @Nullable FieldError getFieldError()
      Description copied from interface: Errors
      Get the first error associated with a field, if any.
      Specified by:
      getFieldError in interface Errors
      Returns:
      the field-specific error, or null
      See Also:

    • hasFieldErrors

      public boolean hasFieldErrors(String field)
      Description copied from interface: Errors
      Determine if there were any errors associated with the given field.
      Specified by:
      hasFieldErrors in interface Errors
      Parameters:
      field - the field name
      See Also:

    • getFieldErrorCount

      public int getFieldErrorCount(String field)
      Description copied from interface: Errors
      Determine the number of errors associated with the given field.
      Specified by:
      getFieldErrorCount in interface Errors
      Parameters:
      field - the field name
      See Also:

    • getFieldErrors

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

      Specified by:
      getFieldErrors in interface Errors
      Parameters:
      field - the field name
      Returns:
      a List of FieldError instances
      See Also:

    • getFieldError

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

    • getFieldValue

      public @Nullable Object getFieldValue(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
      See Also:

    • getFieldType

      public @Nullable Class<?> getFieldType(String field)
      Description copied from interface: Errors
      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.

      Specified by:
      getFieldType in interface Errors
      Parameters:
      field - the field name
      Returns:
      the type of the field, or null if not determinable
      See Also: