|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.validation.DefaultMessageCodesResolver
public class DefaultMessageCodesResolver
Default implementation of the MessageCodesResolver
interface.
Will create two message codes for an object error, in the following order:
Will create four message codes for a field specification, in the following order:
For example, in case of code "typeMismatch", object name "user", field "age":
This resolution algorithm thus can be leveraged for example to show specific messages for binding errors like "required" and "typeMismatch":
In case of array, List
or Map
properties,
both codes for specific elements and for the whole collection are
generated. Assuming a field "name" of an array "groups" in object "user":
In order to group all codes into a specific category within your resource bundles,
e.g. "validation.typeMismatch.name" instead of the default "typeMismatch.name",
consider specifying a prefix
to be applied.
Field Summary | |
---|---|
static String |
CODE_SEPARATOR
The separator that this implementation uses when resolving message codes. |
Constructor Summary | |
---|---|
DefaultMessageCodesResolver()
|
Method Summary | |
---|---|
protected void |
buildFieldList(String field,
List fieldList)
Add both keyed and non-keyed entries for the supplied field
to the supplied field list. |
protected String |
getPrefix()
Return the prefix to be applied to any code built by this resolver. |
protected String |
postProcessMessageCode(String code)
Post-process the given message code, built by this resolver. |
String[] |
resolveMessageCodes(String errorCode,
String objectName)
Build message codes for the given error code and object name. |
String[] |
resolveMessageCodes(String errorCode,
String objectName,
String field,
Class fieldType)
Build the code list for the given code and field: an object/field-specific code, a field-specific code, a plain error code. |
void |
setPrefix(String prefix)
Specify a prefix to be applied to any code built by this resolver. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String CODE_SEPARATOR
Constructor Detail |
---|
public DefaultMessageCodesResolver()
Method Detail |
---|
public void setPrefix(String prefix)
Default is none. Specify, for example, "validation." to get error codes like "validation.typeMismatch.name".
protected String getPrefix()
Returns an empty String in case of no prefix.
public String[] resolveMessageCodes(String errorCode, String objectName)
MessageCodesResolver
resolveMessageCodes
in interface MessageCodesResolver
errorCode
- the error code used for rejecting the objectobjectName
- the name of the object
public String[] resolveMessageCodes(String errorCode, String objectName, String field, Class fieldType)
Arrays, Lists and Maps are resolved both for specific elements and the whole collection.
See the class level Javadoc
for
details on the generated codes.
resolveMessageCodes
in interface MessageCodesResolver
errorCode
- the error code used for rejecting the valueobjectName
- the name of the objectfield
- the field namefieldType
- the field type (may be null
if not determinable)
protected void buildFieldList(String field, List fieldList)
field
to the supplied field list.
protected String postProcessMessageCode(String code)
The default implementation applies the specified prefix, if any.
code
- the message code as built by this resolver
setPrefix(java.lang.String)
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |