The Spring Framework

org.springframework.validation
Class DefaultMessageCodesResolver

java.lang.Object
  extended by org.springframework.validation.DefaultMessageCodesResolver
All Implemented Interfaces:
Serializable, MessageCodesResolver

public class DefaultMessageCodesResolver
extends Object
implements MessageCodesResolver, Serializable

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":

Since:
1.0.1
Author:
Juergen Hoeller
See Also:
Serialized Form

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.
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CODE_SEPARATOR

public static final String CODE_SEPARATOR
The separator that this implementation uses when resolving message codes.

See Also:
Constant Field Values
Constructor Detail

DefaultMessageCodesResolver

public DefaultMessageCodesResolver()
Method Detail

resolveMessageCodes

public String[] resolveMessageCodes(String errorCode,
                                    String objectName)
Description copied from interface: MessageCodesResolver
Build message codes for the given error code and object name. Used for building the codes list of an ObjectError.

Specified by:
resolveMessageCodes in interface MessageCodesResolver
Parameters:
errorCode - the error code used for rejecting the object
objectName - the name of the object
Returns:
the message codes to use

resolveMessageCodes

public 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.

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.

Specified by:
resolveMessageCodes in interface MessageCodesResolver
Parameters:
errorCode - the error code used for rejecting the value
objectName - the name of the object
field - the field name
fieldType - the field type (may be null if not determinable)
Returns:
the list of codes

buildFieldList

protected void buildFieldList(String field,
                              List fieldList)
Add both keyed and non-keyed entries for the supplied field to the supplied field list.


The Spring Framework

Copyright © 2002-2006 The Spring Framework.