|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Throwable
java.lang.Exception
org.springframework.validation.BindException
public class BindException
Thrown when binding errors are considered fatal. Implements the BindingResult interface (and thus its super-interface Errors) to allow for the direct analysis of binding errors.
As of Spring 2.0, this is a special-purpose class. Normally, application
code will work with the BindingResult interface, or a DataBinder that
in turn exposes a BindingResult via
DataBinder.getBindingResult()
.
BindingResult
,
DataBinder.getBindingResult()
,
DataBinder.close()
,
Serialized FormField Summary | |
---|---|
static String |
ERROR_KEY_PREFIX
Deprecated. in favor of BindingResult.MODEL_KEY_PREFIX |
Fields inherited from interface org.springframework.validation.BindingResult |
---|
MODEL_KEY_PREFIX |
Fields inherited from interface org.springframework.validation.Errors |
---|
NESTED_PATH_SEPARATOR |
Constructor Summary | |
---|---|
BindException(BindingResult bindingResult)
Create a new BindException instance for a BindingResult. |
|
BindException(Object target,
String objectName)
Create a new BindException instance for a target bean. |
Method Summary | |
---|---|
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(Object other)
|
List |
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(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(String field)
Return the number of errors associated with the given field. |
List |
getFieldErrors()
Get all errors associated with a field. |
List |
getFieldErrors(String field)
Get all errors associated with the given field. |
Class |
getFieldType(String field)
Return the type of a given field. |
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. |
ObjectError |
getGlobalError()
Get the first global error, if any. |
int |
getGlobalErrorCount()
Return the number of global errors. |
List |
getGlobalErrors()
Get all global errors. |
String |
getMessage()
Returns diagnostic information about the errors held in this object. |
Map |
getModel()
Return a model Map for the obtained state, exposing a BindingResult instance as ' MODEL_KEY_PREFIX + objectName'
and the object itself as 'objectName'. |
String |
getNestedPath()
Return the current nested path of this Errors object. |
String |
getObjectName()
Return the name of the bound root object. |
PropertyEditorRegistry |
getPropertyEditorRegistry()
Return the PropertyEditorRegistry that the underlying BindingResult uses. |
String[] |
getSuppressedFields()
Return the list of fields that were suppressed during the bind process. |
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(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(String subPath)
Push the given sub path onto the nested path stack. |
void |
recordSuppressedField(String fieldName)
Mark the specified disallowed field as suppressed. |
void |
reject(String errorCode)
Register a global error for the entire target object, using the given error description. |
void |
reject(String errorCode,
Object[] errorArgs,
String defaultMessage)
Register a global error for the entire target object, using the given error description. |
void |
reject(String errorCode,
String defaultMessage)
Register a global error for the entire target object, using the given error description. |
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. |
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. |
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. |
String[] |
resolveMessageCodes(String errorCode,
String field)
Resolve the given error code into message codes for the given field. |
void |
setNestedPath(String nestedPath)
Allow context to be changed so that standard validators can validate subtrees. |
Methods inherited from class java.lang.Throwable |
---|
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String ERROR_KEY_PREFIX
BindingResult.MODEL_KEY_PREFIX
BindingResult.MODEL_KEY_PREFIX
Constructor Detail |
---|
public BindException(BindingResult bindingResult)
bindingResult
- the BindingResult instance to wrappublic BindException(Object target, String objectName)
target
- target bean to bind ontoobjectName
- the name of the target objectBeanPropertyBindingResult
Method Detail |
---|
public final BindingResult getBindingResult()
BeanPropertyBindingResult
public final PropertyEditorRegistry getPropertyEditorRegistry()
getPropertyEditorRegistry
in interface BindingResult
null
if none
available for this BindingResultgetBindingResult()
public String getObjectName()
Errors
getObjectName
in interface Errors
public void setNestedPath(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 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(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 IllegalStateException
Errors
popNestedPath
in interface Errors
IllegalStateException
- if there is no former nested path on the stackErrors.pushNestedPath(java.lang.String)
public void reject(String errorCode)
Errors
reject
in interface Errors
errorCode
- error code, interpretable as a message keypublic void reject(String errorCode, String defaultMessage)
Errors
reject
in interface Errors
errorCode
- error code, interpretable as a message keydefaultMessage
- fallback default messagepublic void reject(String errorCode, Object[] errorArgs, String defaultMessage)
Errors
reject
in interface Errors
errorCode
- error code, interpretable as a message keyerrorArgs
- error arguments, for argument binding via MessageFormat
(can be null
)defaultMessage
- fallback default messagepublic void rejectValue(String field, 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(String field, String errorCode, 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(String field, String errorCode, Object[] errorArgs, 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 onvenience 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
hasErrors
in interface Errors
public int getErrorCount()
Errors
getErrorCount
in interface Errors
public List 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 List getGlobalErrors()
Errors
getGlobalErrors
in interface Errors
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 List getFieldErrors()
Errors
getFieldErrors
in interface Errors
FieldError
instancespublic FieldError getFieldError()
Errors
getFieldError
in interface Errors
null
public boolean hasFieldErrors(String field)
Errors
hasFieldErrors
in interface Errors
field
- the field name
true
if there were any errors associated with the given fieldpublic int getFieldErrorCount(String field)
Errors
getFieldErrorCount
in interface Errors
field
- the field name
public List getFieldErrors(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 name
FieldError
instancespublic FieldError getFieldError(String field)
Errors
getFieldError
in interface Errors
field
- the field name
null
public Object getFieldValue(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
public Class getFieldType(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 name
null
if not determinablepublic Object getTarget()
BindingResult
getTarget
in interface BindingResult
public Map 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
,
SimpleFormController
public void recordSuppressedField(String fieldName)
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 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 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 String[] resolveMessageCodes(String errorCode, 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 for
public String getMessage()
getMessage
in class Throwable
public boolean equals(Object other)
equals
in class Object
public int hashCode()
hashCode
in class Object
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |