net.sourceforge.stripes.localization

Class DefaultLocalizationBundleFactory

java.lang.Object

net.sourceforge.stripes.localization.DefaultLocalizationBundleFactory

All Implemented Interfaces:

ConfigurableComponent, LocalizationBundleFactory

public class DefaultLocalizationBundleFactory
extends java.lang.Object
implements LocalizationBundleFactory

Very simple default implementation of a bundle factory. Looks for configuration parameters in the bootstrap properties called "LocalizationBundleFactory.ErrorMessageBundle" and "LocalizationBundleFactory.FieldNameBundle". If one or both of these values is not specified the default bundle name of "StripesResources" will be used in its place.

Author:

Tim Fennell

See Also:

BootstrapPropertyResolver

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BUNDLE_NAME The name of the default resource bundle for Stripes.
static java.lang.String	ERROR_MESSAGE_BUNDLE The configuration parameter for changing the default error message resource bundle.
static java.lang.String	FIELD_NAME_BUNDLE The configuration parameter for changing the default field name resource bundle.

Constructor Summary

Constructors

Constructor and Description
DefaultLocalizationBundleFactory()

Method Summary

Methods

Modifier and Type	Method and Description
protected Configuration	getConfiguration()
java.util.ResourceBundle	getErrorMessageBundle(java.util.Locale locale) Looks for a bundle called StripesResources with the supplied locale if one is provided, or with the default locale if the locale provided is null.
java.util.ResourceBundle	getFormFieldBundle(java.util.Locale locale) Looks for a bundle called StripesResources with the supplied locale if one is provided, or with the default locale if the locale provided is null.
void	init(Configuration configuration) Uses the BootstrapPropertyResolver attached to the Configuration in order to look for configured bundle names in the servlet init parameters etc.
protected void	setConfiguration(Configuration configuration)

Methods inherited from class java.lang.Object

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

Field Detail

BUNDLE_NAME

public static final java.lang.String BUNDLE_NAME

The name of the default resource bundle for Stripes.

See Also:

Constant Field Values

ERROR_MESSAGE_BUNDLE

public static final java.lang.String ERROR_MESSAGE_BUNDLE

The configuration parameter for changing the default error message resource bundle.

See Also:

Constant Field Values

FIELD_NAME_BUNDLE

public static final java.lang.String FIELD_NAME_BUNDLE

The configuration parameter for changing the default field name resource bundle.

See Also:

Constant Field Values

Constructor Detail

DefaultLocalizationBundleFactory

public DefaultLocalizationBundleFactory()

Method Detail

init

public void init(Configuration configuration)
          throws java.lang.Exception

Uses the BootstrapPropertyResolver attached to the Configuration in order to look for configured bundle names in the servlet init parameters etc. If those can't be found then the default bundle names are put in place.

Specified by:

init in interface ConfigurableComponent

Parameters:

configuration - the Configuration object being used by Stripes

Throws:

java.lang.Exception - should be thrown if the component cannot be configured well enough to use.

getErrorMessageBundle

public java.util.ResourceBundle getErrorMessageBundle(java.util.Locale locale)
                                               throws java.util.MissingResourceException

Looks for a bundle called StripesResources with the supplied locale if one is provided, or with the default locale if the locale provided is null.

Specified by:

getErrorMessageBundle in interface LocalizationBundleFactory

Parameters:

locale - an optional locale, may be null.

Returns:

ResourceBundle a bundle in which to look for localized error messages

Throws:

java.util.MissingResourceException - if a suitable bundle cannot be found

getFormFieldBundle

public java.util.ResourceBundle getFormFieldBundle(java.util.Locale locale)
                                            throws java.util.MissingResourceException

Looks for a bundle called StripesResources with the supplied locale if one is provided, or with the default locale if the locale provided is null.

Specified by:

getFormFieldBundle in interface LocalizationBundleFactory

Parameters:

locale - an optional locale, may be null.

Returns:

ResourceBundle a bundle in which to look for localized field names

Throws:

java.util.MissingResourceException - if a suitable bundle cannot be found

getConfiguration

protected Configuration getConfiguration()

setConfiguration

protected void setConfiguration(Configuration configuration)