程序包 cn.taketoday.validation

类 BindException

java.lang.Object
java.lang.Throwable
java.lang.Exception
cn.taketoday.validation.BindException
所有已实现的接口:
BindingResult, Errors, Serializable
public class BindException extends Exception implements BindingResult
Thrown when binding errors are considered fatal. Implements the BindingResult interface (and its super-interface Errors) to allow for the direct analysis of binding errors.

this is a special-purpose class. Normally, application code will work with the BindingResult interface, or with a DataBinder that in turn exposes a BindingResult via DataBinder.getBindingResult().

从以下版本开始:
4.0
作者:
Rod Johnson, Juergen Hoeller, Rob Harrop
另请参阅:

  • 构造器详细资料

    • BindException

      public BindException(BindingResult bindingResult)
      Create a new BindException instance for a BindingResult.
      参数:
      bindingResult - the BindingResult instance to wrap

    • BindException

      public BindException(Object target, String objectName)
      Create a new BindException instance for a target bean.
      参数:
      target - the target bean to bind onto
      objectName - the name of the target object
      另请参阅:

  • 方法详细资料

    • getBindingResult

      public final BindingResult getBindingResult()
      Return the BindingResult that this BindException wraps.

    • getObjectName

      public String getObjectName()
      从接口复制的说明: Errors
      Return the name of the bound root object.
      指定者:
      getObjectName 在接口中 Errors

    • setNestedPath

      public void setNestedPath(String nestedPath)
      从接口复制的说明: 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.

      指定者:
      setNestedPath 在接口中 Errors
      参数:
      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

      public String getNestedPath()
      从接口复制的说明: 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.

      指定者:
      getNestedPath 在接口中 Errors

    • pushNestedPath

      public void pushNestedPath(String subPath)
      从接口复制的说明: 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.

      指定者:
      pushNestedPath 在接口中 Errors
      参数:
      subPath - the sub path to push onto the nested path stack
      另请参阅:

    • popNestedPath

      public void popNestedPath() throws IllegalStateException
      从接口复制的说明: Errors
      Pop the former nested path from the nested path stack.
      指定者:
      popNestedPath 在接口中 Errors
      抛出:
      IllegalStateException - if there is no former nested path on the stack
      另请参阅:

    • reject

      public void reject(String errorCode)
      从接口复制的说明: Errors
      Register a global error for the entire target object, using the given error description.
      指定者:
      reject 在接口中 Errors
      参数:
      errorCode - error code, interpretable as a message key

    • reject

      public void reject(String errorCode, String defaultMessage)
      从接口复制的说明: Errors
      Register a global error for the entire target object, using the given error description.
      指定者:
      reject 在接口中 Errors
      参数:
      errorCode - error code, interpretable as a message key
      defaultMessage - fallback default message

    • reject

      public void reject(String errorCode, @Nullable Object[] errorArgs, @Nullable String defaultMessage)
      从接口复制的说明: Errors
      Register a global error for the entire target object, using the given error description.
      指定者:
      reject 在接口中 Errors
      参数:
      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 String field, String errorCode)
      从接口复制的说明: 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.

      指定者:
      rejectValue 在接口中 Errors
      参数:
      field - the field name (may be null or empty String)
      errorCode - error code, interpretable as a message key
      另请参阅:

    • rejectValue

      public void rejectValue(@Nullable String field, String errorCode, String defaultMessage)
      从接口复制的说明: 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.

      指定者:
      rejectValue 在接口中 Errors
      参数:
      field - the field name (may be null or empty String)
      errorCode - error code, interpretable as a message key
      defaultMessage - fallback default message
      另请参阅:

    • rejectValue

      public void rejectValue(@Nullable String field, String errorCode, @Nullable Object[] errorArgs, @Nullable String defaultMessage)
      从接口复制的说明: 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.

      指定者:
      rejectValue 在接口中 Errors
      参数:
      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
      另请参阅:

    • addAllErrors

      public void addAllErrors(Errors 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.

      指定者:
      addAllErrors 在接口中 Errors
      参数:
      errors - the Errors instance to merge in

    • hasErrors

      public boolean hasErrors()
      从接口复制的说明: Errors
      Return if there were any errors.
      指定者:
      hasErrors 在接口中 Errors

    • getErrorCount

      public int getErrorCount()
      从接口复制的说明: Errors
      Return the total number of errors.
      指定者:
      getErrorCount 在接口中 Errors

    • getAllErrors

      public List<ObjectError> getAllErrors()
      从接口复制的说明: Errors
      Get all errors, both global and field ones.
      指定者:
      getAllErrors 在接口中 Errors
      返回:
      a list of ObjectError instances

    • hasGlobalErrors

      public boolean hasGlobalErrors()
      从接口复制的说明: Errors
      Are there any global errors?
      指定者:
      hasGlobalErrors 在接口中 Errors
      返回:
      true if there are any global errors
      另请参阅:

    • getGlobalErrorCount

      public int getGlobalErrorCount()
      从接口复制的说明: Errors
      Return the number of global errors.
      指定者:
      getGlobalErrorCount 在接口中 Errors
      返回:
      the number of global errors
      另请参阅:

    • getGlobalErrors

      public List<ObjectError> getGlobalErrors()
      从接口复制的说明: Errors
      Get all global errors.
      指定者:
      getGlobalErrors 在接口中 Errors
      返回:
      a list of ObjectError instances

    • getGlobalError

      @Nullable public ObjectError getGlobalError()
      从接口复制的说明: Errors
      Get the first global error, if any.
      指定者:
      getGlobalError 在接口中 Errors
      返回:
      the global error, or null

    • hasFieldErrors

      public boolean hasFieldErrors()
      从接口复制的说明: Errors
      Are there any field errors?
      指定者:
      hasFieldErrors 在接口中 Errors
      返回:
      true if there are any errors associated with a field
      另请参阅:

    • getFieldErrorCount

      public int getFieldErrorCount()
      从接口复制的说明: Errors
      Return the number of errors associated with a field.
      指定者:
      getFieldErrorCount 在接口中 Errors
      返回:
      the number of errors associated with a field
      另请参阅:

    • getFieldErrors

      public List<FieldError> getFieldErrors()
      从接口复制的说明: Errors
      Get all errors associated with a field.
      指定者:
      getFieldErrors 在接口中 Errors
      返回:
      a List of FieldError instances

    • getFieldError

      @Nullable public FieldError getFieldError()
      从接口复制的说明: Errors
      Get the first error associated with a field, if any.
      指定者:
      getFieldError 在接口中 Errors
      返回:
      the field-specific error, or null

    • hasFieldErrors

      public boolean hasFieldErrors(String field)
      从接口复制的说明: Errors
      Are there any errors associated with the given field?
      指定者:
      hasFieldErrors 在接口中 Errors
      参数:
      field - the field name
      返回:
      true if there were any errors associated with the given field

    • getFieldErrorCount

      public int getFieldErrorCount(String field)
      从接口复制的说明: Errors
      Return the number of errors associated with the given field.
      指定者:
      getFieldErrorCount 在接口中 Errors
      参数:
      field - the field name
      返回:
      the number of errors associated with the given field

    • getFieldErrors

      public List<FieldError> getFieldErrors(String field)
      从接口复制的说明: 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.*".

      指定者:
      getFieldErrors 在接口中 Errors
      参数:
      field - the field name
      返回:
      a List of FieldError instances

    • getFieldError

      @Nullable public FieldError getFieldError(String field)
      从接口复制的说明: Errors
      Get the first error associated with the given field, if any.
      指定者:
      getFieldError 在接口中 Errors
      参数:
      field - the field name
      返回:
      the field-specific error, or null

    • getFieldValue

      @Nullable public Object getFieldValue(String field)
      从接口复制的说明: 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.

      指定者:
      getFieldValue 在接口中 Errors
      参数:
      field - the field name
      返回:
      the current value of the given field

    • getFieldType

      @Nullable public Class<?> getFieldType(String field)
      从接口复制的说明: Errors
      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.

      指定者:
      getFieldType 在接口中 Errors
      参数:
      field - the field name
      返回:
      the type of the field, or null if not determinable

    • getTarget

      @Nullable public Object getTarget()
      从接口复制的说明: BindingResult
      Return the wrapped target object, which may be a bean, an object with public fields, a Map - depending on the concrete binding strategy.
      指定者:
      getTarget 在接口中 BindingResult

    • getModel

      public Map<String,Object> getModel()
      从接口复制的说明: BindingResult
      Return a model Map for the obtained state, exposing a BindingResult instance as 'MODEL_KEY_PREFIX + objectName' and the object itself as 'objectName'.

      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 cn.taketoday.web.view.ModelAndView for a form view that uses Framework's bind tag in a JSP, which needs access to the BindingResult instance. Framework's pre-built form controllers will do this for you when rendering a form view. When building the ModelAndView instance yourself, you need to include the attributes from the model Map returned by this method.

      指定者:
      getModel 在接口中 BindingResult
      另请参阅:

    • getRawFieldValue

      @Nullable public Object getRawFieldValue(String field)
      从接口复制的说明: BindingResult
      Extract the raw field value for the given field. Typically used for comparison purposes.
      指定者:
      getRawFieldValue 在接口中 BindingResult
      参数:
      field - the field to check
      返回:
      the current value of the field in its raw form, or null if not known

    • findEditor

      @Nullable public PropertyEditor findEditor(@Nullable String field, @Nullable Class valueType)
      从接口复制的说明: BindingResult
      Find a custom property editor for the given type and property.
      指定者:
      findEditor 在接口中 BindingResult
      参数:
      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)
      返回:
      the registered editor, or null if none

    • getPropertyEditorRegistry

      @Nullable public PropertyEditorRegistry getPropertyEditorRegistry()
      从接口复制的说明: BindingResult
      Return the underlying PropertyEditorRegistry.
      指定者:
      getPropertyEditorRegistry 在接口中 BindingResult
      返回:
      the PropertyEditorRegistry, or null if none available for this BindingResult

    • resolveMessageCodes

      public String[] resolveMessageCodes(String errorCode)
      从接口复制的说明: BindingResult
      Resolve the given error code into message codes.

      Calls the configured MessageCodesResolver with appropriate parameters.

      指定者:
      resolveMessageCodes 在接口中 BindingResult
      参数:
      errorCode - the error code to resolve into message codes
      返回:
      the resolved message codes

    • resolveMessageCodes

      public String[] resolveMessageCodes(String errorCode, String field)
      从接口复制的说明: BindingResult
      Resolve the given error code into message codes for the given field.

      Calls the configured MessageCodesResolver with appropriate parameters.

      指定者:
      resolveMessageCodes 在接口中 BindingResult
      参数:
      errorCode - the error code to resolve into message codes
      field - the field to resolve message codes for
      返回:
      the resolved message codes

    • addError

      public void addError(ObjectError error)
      从接口复制的说明: BindingResult
      Add a custom ObjectError or FieldError to the errors list.

      Intended to be used by cooperating strategies such as BindingErrorProcessor.

      指定者:
      addError 在接口中 BindingResult
      另请参阅:

    • recordFieldValue

      public void recordFieldValue(String field, Class<?> type, @Nullable Object value)
      从接口复制的说明: 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.

      指定者:
      recordFieldValue 在接口中 BindingResult
      参数:
      field - the field to record the value for
      type - the type of the field
      value - the original value

    • recordSuppressedField

      public void recordSuppressedField(String field)
      从接口复制的说明: BindingResult
      Mark the specified disallowed field as suppressed.

      The data binder invokes this for each field value that was detected to target a disallowed field.

      指定者:
      recordSuppressedField 在接口中 BindingResult
      另请参阅:

    • getSuppressedFields

      public String[] getSuppressedFields()
      从接口复制的说明: BindingResult
      Return the list of fields that were suppressed during the bind process.

      Can be used to determine whether any field values were targeting disallowed fields.

      指定者:
      getSuppressedFields 在接口中 BindingResult
      另请参阅:

    • getMessage

      public String getMessage()
      Returns diagnostic information about the errors held in this object.
      覆盖:
      getMessage 在类中 Throwable

    • equals

      public boolean equals(@Nullable Object other)
      覆盖:
      equals 在类中 Object

    • hashCode

      public int hashCode()
      覆盖:
      hashCode 在类中 Object