net.sourceforge.stripes.validation
Class LocalizableError

java.lang.Object
  net.sourceforge.stripes.validation.SimpleError
      net.sourceforge.stripes.validation.LocalizableError

All Implemented Interfaces:

ValidationError

Direct Known Subclasses:

ScopedLocalizableError

public class LocalizableError
extends SimpleError

Provides a mechanism for creating localizable error messages for presentation to the user. Uses ResourceBundles to provide the localization of the error message. Messages may contain one or more "replacement parameters ". Two replacement parameters are provided by default, they are the field name and field value, and are indices 0 and 1 respectively. To use replacement parameters a message must contain the replacement token {#} where # is the numeric index of the replacement parameter.

For example, to construct an error message with one additional replacement parameter which is the action the user was trying to perform, you might have a properties file entry like:

/action/MyAction.myErrorMessage={1} is not a valid {0} when trying to {2}

At runtime this might get replaced out to result in an error message for the user that looks like "Fixed is not a valid status when trying to create a new bug".

One last point of interest is where the user friendly field name comes from. Firstly an attempt is made to look up the localized name in the applicable resource bundle using the String actionPath.fieldName where actionPath is the action of the form in the JSP (or equally, the path given in the @UrlBinding annotation in the ActionBean class), and fieldName is the name of the field on the form.

See Also:

MessageFormat, ResourceBundle

Field Summary

static Log

log Log class used to log debugging information.

Fields inherited from class net.sourceforge.stripes.validation.SimpleError

replacementParameters

Constructor Summary

LocalizableError(String messageKey, Object... parameter)
Creates a new LocalizableError with the message key provided, and optionally zero or more replacement parameters to use in the message.

Method Summary

boolean	equals(Object o) Generated equals method that compares each field and super.equals().
protected String	getMessageTemplate(Locale locale) Method responsible for using the information supplied to the error object to find a message template.
int	hashCode() Generated hashCode method.

Methods inherited from class net.sourceforge.stripes.validation.SimpleError

getActionPath, getFieldName, getFieldValue, getMessage, resolveFieldName, setActionPath, setFieldName, setFieldValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

public static final Log log

Log class used to log debugging information.

Constructor Detail

LocalizableError

public LocalizableError(String messageKey,
                        Object... parameter)

Creates a new LocalizableError with the message key provided, and optionally zero or more replacement parameters to use in the message. It should be noted that the replacement parameters provided here can be referenced in the error message starting with number 2.

Parameters:

messageKey - a key to lookup a message in the resource bundle

parameter - one or more replacement parameters to insert into the message

Method Detail

getMessageTemplate

protected String getMessageTemplate(Locale locale)

Method responsible for using the information supplied to the error object to find a message template. In this class this is done simply by looking up the resource corresponding to the messageKey supplied in the constructor.

Overrides:

getMessageTemplate in class SimpleError

Parameters:

locale - the Locale of the message template desired

Returns:

the message (potentially with TextFormat replacement tokens).

equals

public boolean equals(Object o)

Generated equals method that compares each field and super.equals().

Overrides:

equals in class SimpleError

hashCode

public int hashCode()

Generated hashCode method.

Overrides:

hashCode in class SimpleError