flex.messaging.util

Class PropertyStringResourceLoader

java.lang.Object

flex.messaging.util.PropertyStringResourceLoader

All Implemented Interfaces:

ResourceLoader

public class PropertyStringResourceLoader
extends Object
implements ResourceLoader

Implementation of ResourceLoader that loads string resources from property files.

This class uses MessageFormat to perform substitutions within parameterized strings.

Author:

Seth Hodgson

See Also:

MessageFormat

Field Summary

Fields

Modifier and Type	Field and Description
static String	LCDS_PROPERTY_BUNDLE
static String	PROPERTY_BUNDLE
static String	VENDORS_BUNDLE

Constructor Summary

Constructors

Constructor and Description
PropertyStringResourceLoader() Constructs a PropertyStringResourceLoader using the default property bundles specified by the PROPERTY_BUNDLE and LCDS_PROPERTY_BUNDLE fields.
PropertyStringResourceLoader(String propertyBundle) Constructs a PropertyStringResourceLoader that will use the specified property bundle to use for string lookups.
PropertyStringResourceLoader(String[] propertyBundles) Constructs a PropertyStringResourceLoader that will use the specified property bundles to use for string lookups.

Method Summary

Methods

Modifier and Type	Method and Description
Locale	getDefaultLocale() The default locale to be used when locating resources.
String	getString(String key) Gets a string for the given key.
String	getString(String key, Locale locale) Gets a string for the given key and locale.
String	getString(String key, Locale locale, Object[] arguments) Gets a parameterized string for the given key and locale and substitutes the parameters using the passed array of arguments.
String	getString(String key, Object[] arguments) Gets a parameterized string for the given key and substitutes the parameters using the passed array of arguments.
void	init(Map properties) Initializes the ResourceLoader using the specified properties.
protected InputStream	loadFile(String filename)
protected void	loadProperties(String localeKey, String propertyBundle)
protected void	loadStrings(String localeKey) Loads localized strings for the specified locale from a property file.
void	setDefaultLocale(Locale locale) Sets the default locale to be used when locating resources.
void	setDefaultLocale(String locale) Sets the default locale to be used when locating resources.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_BUNDLE

public static final String PROPERTY_BUNDLE

See Also:

Constant Field Values

VENDORS_BUNDLE

public static final String VENDORS_BUNDLE

See Also:

Constant Field Values

LCDS_PROPERTY_BUNDLE

public static final String LCDS_PROPERTY_BUNDLE

See Also:

Constant Field Values

Constructor Detail

PropertyStringResourceLoader

public PropertyStringResourceLoader()

Constructs a PropertyStringResourceLoader using the default property bundles specified by the PROPERTY_BUNDLE and LCDS_PROPERTY_BUNDLE fields.

PropertyStringResourceLoader

public PropertyStringResourceLoader(String propertyBundle)

Constructs a PropertyStringResourceLoader that will use the specified property bundle to use for string lookups.

Parameters:

propertyBundle - The property bundles to use for lookups.

PropertyStringResourceLoader

public PropertyStringResourceLoader(String[] propertyBundles)

Constructs a PropertyStringResourceLoader that will use the specified property bundles to use for string lookups.

Parameters:

propertyBundles - The list of the property bundles to use for lookups.

Method Detail

init

public void init(Map properties)

Description copied from interface: ResourceLoader

Initializes the ResourceLoader using the specified properties.

Specified by:

init in interface ResourceLoader

Parameters:

properties - The initialization properties.

getString

public String getString(String key)

Description copied from interface: ResourceLoader

Gets a string for the given key.

Specified by:

getString in interface ResourceLoader

Parameters:

key - The key for the target string.

Returns:

The string for the given key.

getString

public String getString(String key,
               Object[] arguments)

Description copied from interface: ResourceLoader

Gets a parameterized string for the given key and substitutes the parameters using the passed array of arguments.

Specified by:

getString in interface ResourceLoader

Parameters:

key - The key for the target string.

arguments - The arguments to substitute into the parameterized string.

Returns:

The substituted string for the given key.

getString

public String getString(String key,
               Locale locale)

Description copied from interface: ResourceLoader

Gets a string for the given key and locale.

Specified by:

getString in interface ResourceLoader

Parameters:

key - The key for the target string.

locale - The target locale for the string.

Returns:

The localized string for the given key.

getString

public String getString(String key,
               Locale locale,
               Object[] arguments)

Description copied from interface: ResourceLoader

Gets a parameterized string for the given key and locale and substitutes the parameters using the passed array of arguments.

Specified by:

getString in interface ResourceLoader

Parameters:

key - The key for the target string.

locale - The target locale for the string.

arguments - The arguments to substitute into the parameterized string.

Returns:

The substituted localized string for the given key.

setDefaultLocale

public void setDefaultLocale(String locale)

Sets the default locale to be used when locating resources. The string will be converted into a Locale.

Specified by:

setDefaultLocale in interface ResourceLoader

Parameters:

locale - The default locale to be used.

setDefaultLocale

public void setDefaultLocale(Locale locale)

Sets the default locale to be used when locating resources.

Specified by:

setDefaultLocale in interface ResourceLoader

Parameters:

locale - The default locale to be used.

getDefaultLocale

public Locale getDefaultLocale()

The default locale to be used when locating resources.

Specified by:

getDefaultLocale in interface ResourceLoader

Returns:

Locale the default Locale object

loadStrings

protected void loadStrings(String localeKey)

Loads localized strings for the specified locale from a property file.

Parameters:

localeKey - The locale to load strings for.

loadFile

protected InputStream loadFile(String filename)

loadProperties

protected void loadProperties(String localeKey,
                  String propertyBundle)