|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.web.bind.EscapedErrors
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.
RequestContext.getErrors(java.lang.String)
,
BindTag
Field Summary |
---|
Fields inherited from interface org.springframework.validation.Errors |
---|
NESTED_PATH_SEPARATOR |
Constructor Summary | |
---|---|
EscapedErrors(Errors source)
Create a new EscapedErrors instance for the given source instance. |
Method Summary | |
---|---|
void |
addAllErrors(Errors errors)
Add all errors from the given Errors instance to this
Errors instance. |
List |
getAllErrors()
Get all errors, both global and field ones. |
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 |
getNestedPath()
Return the current nested path of this Errors object. |
String |
getObjectName()
Return the name of the bound root object. |
Errors |
getSource()
|
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? |
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 |
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. |
void |
setNestedPath(String nestedPath)
Allow context to be changed so that standard validators can validate subtrees. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EscapedErrors(Errors source)
Method Detail |
---|
public Errors getSource()
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
errorCode
- error code, interpretable as a message keypublic void reject(String errorCode, String defaultMessage)
Errors
errorCode
- error code, interpretable as a message keydefaultMessage
- fallback default messagepublic void reject(String errorCode, Object[] errorArgs, String defaultMessage)
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
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 determinable
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |