public class WebExchangeBindException extends ServerWebInputException implements BindingResult
ServerWebInputException
thrown when after data
binding and validation failure. Implements BindingResult
(and its
super-interface Errors
) to allow for direct analysis of binding and
validation errors.Modifier and Type | Field and Description |
---|---|
private BindingResult |
bindingResult |
MODEL_KEY_PREFIX
NESTED_PATH_SEPARATOR
Constructor and Description |
---|
WebExchangeBindException(MethodParameter parameter,
BindingResult bindingResult) |
Modifier and Type | Method and Description |
---|---|
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(java.lang.Object other) |
java.beans.PropertyEditor |
findEditor(java.lang.String field,
java.lang.Class valueType)
Find a custom property editor for the given type and property.
|
java.util.List<ObjectError> |
getAllErrors()
Get all errors, both global and field ones.
|
BindingResult |
getBindingResult()
Return the BindingResult that this BindException wraps.
|
int |
getErrorCount()
Return the total number of errors.
|
FieldError |
getFieldError()
Get the first error associated with a field, if any.
|
FieldError |
getFieldError(java.lang.String field)
Get the first error associated with the given field, if any.
|
int |
getFieldErrorCount()
Return the number of errors associated with a field.
|
int |
getFieldErrorCount(java.lang.String field)
Return the number of errors associated with the given field.
|
java.util.List<FieldError> |
getFieldErrors()
Get all errors associated with a field.
|
java.util.List<FieldError> |
getFieldErrors(java.lang.String field)
Get all errors associated with the given field.
|
java.lang.Class<?> |
getFieldType(java.lang.String field)
Return the type of a given field.
|
java.lang.Object |
getFieldValue(java.lang.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.
|
int |
getGlobalErrorCount()
Return the number of global errors.
|
java.util.List<ObjectError> |
getGlobalErrors()
Get all global errors.
|
java.lang.String |
getMessage()
Returns diagnostic information about the errors held in this object.
|
java.util.Map<java.lang.String,java.lang.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'. |
java.lang.String |
getNestedPath()
Return the current nested path of this
Errors object. |
java.lang.String |
getObjectName()
Return the name of the bound root object.
|
PropertyEditorRegistry |
getPropertyEditorRegistry()
Return the underlying PropertyEditorRegistry.
|
java.lang.Object |
getRawFieldValue(java.lang.String field)
Extract the raw field value for the given field.
|
java.lang.String[] |
getSuppressedFields()
Return the list of fields that were suppressed during the bind process.
|
java.lang.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.
|
boolean |
hasErrors()
Return if there were any errors.
|
boolean |
hasFieldErrors()
Are there any field errors?
|
boolean |
hasFieldErrors(java.lang.String field)
Are there any errors associated with the given field?
|
boolean |
hasGlobalErrors()
Are there any global errors?
|
int |
hashCode() |
void |
popNestedPath()
Pop the former nested path from the nested path stack.
|
void |
pushNestedPath(java.lang.String subPath)
Push the given sub path onto the nested path stack.
|
void |
recordSuppressedField(java.lang.String field)
Mark the specified disallowed field as suppressed.
|
void |
reject(java.lang.String errorCode)
Register a global error for the entire target object,
using the given error description.
|
void |
reject(java.lang.String errorCode,
java.lang.Object[] errorArgs,
java.lang.String defaultMessage)
Register a global error for the entire target object,
using the given error description.
|
void |
reject(java.lang.String errorCode,
java.lang.String defaultMessage)
Register a global error for the entire target object,
using the given error description.
|
void |
rejectValue(java.lang.String field,
java.lang.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 |
rejectValue(java.lang.String field,
java.lang.String errorCode,
java.lang.Object[] errorArgs,
java.lang.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(java.lang.String field,
java.lang.String errorCode,
java.lang.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.
|
java.lang.String[] |
resolveMessageCodes(java.lang.String errorCode)
Resolve the given error code into message codes.
|
java.lang.String[] |
resolveMessageCodes(java.lang.String errorCode,
java.lang.String field)
Resolve the given error code into message codes for the given field.
|
void |
setNestedPath(java.lang.String nestedPath)
Allow context to be changed so that standard validators can validate
subtrees.
|
getMethodParameter
getReason, getStatus
contains, getMostSpecificCause, getRootCause
private final BindingResult bindingResult
public WebExchangeBindException(MethodParameter parameter, BindingResult bindingResult)
public final BindingResult getBindingResult()
BeanPropertyBindingResult
public java.lang.String getObjectName()
Errors
getObjectName
in interface Errors
public void setNestedPath(java.lang.String nestedPath)
Errors
For example, an address validator could validate the subobject "address" of a customer object.
setNestedPath
in interface 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.public java.lang.String getNestedPath()
Errors
Errors
object.
Returns a nested path with a dot, i.e. "address.", for easy building of concatenated paths. Default is an empty String.
getNestedPath
in interface Errors
public void pushNestedPath(java.lang.String subPath)
Errors
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
in interface Errors
subPath
- the sub path to push onto the nested path stackErrors.popNestedPath()
public void popNestedPath() throws java.lang.IllegalStateException
Errors
popNestedPath
in interface Errors
java.lang.IllegalStateException
- if there is no former nested path on the stackErrors.pushNestedPath(java.lang.String)
public void reject(java.lang.String errorCode)
Errors
public void reject(java.lang.String errorCode, java.lang.String defaultMessage)
Errors
public void reject(java.lang.String errorCode, @Nullable java.lang.Object[] errorArgs, @Nullable java.lang.String defaultMessage)
Errors
public void rejectValue(@Nullable java.lang.String field, java.lang.String errorCode)
Errors
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
in interface Errors
field
- the field name (may be null
or empty String)errorCode
- error code, interpretable as a message keyErrors.getNestedPath()
public void rejectValue(@Nullable java.lang.String field, java.lang.String errorCode, java.lang.String defaultMessage)
Errors
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
in interface Errors
field
- the field name (may be null
or empty String)errorCode
- error code, interpretable as a message keydefaultMessage
- fallback default messageErrors.getNestedPath()
public void rejectValue(@Nullable java.lang.String field, java.lang.String errorCode, @Nullable java.lang.Object[] errorArgs, @Nullable java.lang.String defaultMessage)
Errors
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
in interface Errors
field
- the field name (may be null
or empty String)errorCode
- error code, interpretable as a message keyerrorArgs
- error arguments, for argument binding via MessageFormat
(can be null
)defaultMessage
- fallback default messageErrors.getNestedPath()
public void addAllErrors(Errors errors)
Errors
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
in interface Errors
errors
- the Errors
instance to merge inpublic boolean hasErrors()
Errors
public int getErrorCount()
Errors
getErrorCount
in interface Errors
public java.util.List<ObjectError> getAllErrors()
Errors
getAllErrors
in interface Errors
ObjectError
instancespublic boolean hasGlobalErrors()
Errors
hasGlobalErrors
in interface Errors
true
if there are any global errorsErrors.hasFieldErrors()
public int getGlobalErrorCount()
Errors
getGlobalErrorCount
in interface Errors
Errors.getFieldErrorCount()
public java.util.List<ObjectError> getGlobalErrors()
Errors
getGlobalErrors
in interface Errors
@Nullable public ObjectError getGlobalError()
Errors
getGlobalError
in interface Errors
null
public boolean hasFieldErrors()
Errors
hasFieldErrors
in interface Errors
true
if there are any errors associated with a fieldErrors.hasGlobalErrors()
public int getFieldErrorCount()
Errors
getFieldErrorCount
in interface Errors
Errors.getGlobalErrorCount()
public java.util.List<FieldError> getFieldErrors()
Errors
getFieldErrors
in interface Errors
FieldError
instances@Nullable public FieldError getFieldError()
Errors
getFieldError
in interface Errors
null
public boolean hasFieldErrors(java.lang.String field)
Errors
hasFieldErrors
in interface Errors
field
- the field nametrue
if there were any errors associated with the given fieldpublic int getFieldErrorCount(java.lang.String field)
Errors
getFieldErrorCount
in interface Errors
field
- the field namepublic java.util.List<FieldError> getFieldErrors(java.lang.String field)
Errors
Implementations should support not only full field names like "name" but also pattern matches like "na*" or "address.*".
getFieldErrors
in interface Errors
field
- the field nameFieldError
instances@Nullable public FieldError getFieldError(java.lang.String field)
Errors
getFieldError
in interface Errors
field
- the field namenull
@Nullable public java.lang.Object getFieldValue(java.lang.String field)
Errors
Allows for convenient access to user-specified field values, even if there were type mismatches.
getFieldValue
in interface Errors
field
- the field name@Nullable public java.lang.Class<?> getFieldType(java.lang.String field)
Errors
Implementations should be able to determine the type even
when the field value is null
, for example from some
associated descriptor.
getFieldType
in interface Errors
field
- the field namenull
if not determinablepublic java.lang.Object getTarget()
BindingResult
getTarget
in interface BindingResult
public java.util.Map<java.lang.String,java.lang.Object> getModel()
BindingResult
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 ModelAndView
for a form view that uses Spring's bind
tag in a JSP,
which needs access to the BindingResult instance. Spring'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
in interface BindingResult
Errors.getObjectName()
,
BindingResult.MODEL_KEY_PREFIX
,
ModelAndView
,
BindTag
@Nullable public java.lang.Object getRawFieldValue(java.lang.String field)
BindingResult
getRawFieldValue
in interface BindingResult
field
- the field to checknull
if not known@Nullable public java.beans.PropertyEditor findEditor(@Nullable java.lang.String field, @Nullable java.lang.Class valueType)
BindingResult
findEditor
in interface BindingResult
field
- the path of the property (name or nested path), or
null
if looking for an editor for all properties of the given typevalueType
- the type of the property (can be null
if a property
is given but should be specified in any case for consistency checking)null
if none@Nullable public PropertyEditorRegistry getPropertyEditorRegistry()
BindingResult
getPropertyEditorRegistry
in interface BindingResult
null
if none
available for this BindingResultpublic void addError(ObjectError error)
BindingResult
ObjectError
or FieldError
to the errors list.
Intended to be used by cooperating strategies such as BindingErrorProcessor
.
addError
in interface BindingResult
ObjectError
,
FieldError
,
BindingErrorProcessor
public java.lang.String[] resolveMessageCodes(java.lang.String errorCode)
BindingResult
Calls the configured MessageCodesResolver
with appropriate parameters.
resolveMessageCodes
in interface BindingResult
errorCode
- the error code to resolve into message codespublic java.lang.String[] resolveMessageCodes(java.lang.String errorCode, java.lang.String field)
BindingResult
Calls the configured MessageCodesResolver
with appropriate parameters.
resolveMessageCodes
in interface BindingResult
errorCode
- the error code to resolve into message codesfield
- the field to resolve message codes forpublic void recordSuppressedField(java.lang.String field)
BindingResult
The data binder invokes this for each field value that was detected to target a disallowed field.
recordSuppressedField
in interface BindingResult
DataBinder.setAllowedFields(java.lang.String...)
public java.lang.String[] getSuppressedFields()
BindingResult
Can be used to determine whether any field values were targeting disallowed fields.
getSuppressedFields
in interface BindingResult
DataBinder.setAllowedFields(java.lang.String...)
public java.lang.String getMessage()
getMessage
in class ResponseStatusException
public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object