Package org.faktorips.datatype.util

Class LocalizedStringsSet

java.lang.Object

org.faktorips.datatype.util.LocalizedStringsSet

public class LocalizedStringsSet
extends Object

A LocalizedStringsSet is a set of strings available in different locales. A localized string can be looked up by a locale independent key and a locale.

The locale dependent strings have to be stored in property files. They are accessed via Java's ResourceBundle. To access the property files, they all have to be in the same package and must start with the same prefix. Therefore the set's qualified name is the package name, followed by a dot (.), followed by the prefix, e.g. "org.faktorips.fl.Messages". For further information see the ResourceBundle documentation.

If a localized String contains sections that have to be replaced with locale dependent replacements before the String is presented to a user, you can use one of the methods taking replacement objects as a parameter. The mechanism used here is the one of MessageFormat.

Example:

In the message "The sum insured must be at least {0}." the sum insured must be inserted at runtime depending on the chosen product.

Constructor Summary

Constructors

Constructor	Description
LocalizedStringsSet(Class<?> clazz)	Creates a new set that uses the indicated class' name as qualified name.
LocalizedStringsSet(String qualifiedName, ClassLoader loader)	Creates a new StringsSet with the indicated qualified name.

Method Summary

Modifier and Type	Method	Description
String	getString(String key)	Try to load the resource bundle in the jvm's default language and searches for the given key.
String	getString(String key, Object... replacements)	Try to load the resource bundle in the jvm's default language and searches for the given key.
String	getString(String key, Locale locale)	Try to load the resource bundle in given locale and searches for the given key.
String	getString(String key, Locale locale, Object... replacements)	Try to load the resource bundle in given locale and searches for the given key.
boolean	isAccessible(Locale locale)	Checking whether the resource is accessible in given locale.

Methods inherited from class java.lang.Object

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

Constructor Details

LocalizedStringsSet

public LocalizedStringsSet(Class<?> clazz)

Creates a new set that uses the indicated class' name as qualified name.

Throws:

IllegalArgumentException - if the clazz is null.

LocalizedStringsSet

public LocalizedStringsSet(String qualifiedName,
 ClassLoader loader)

Creates a new StringsSet with the indicated qualified name. The property files are loaded with the indicated classloader.

Throws:

IllegalArgumentException - if the qualifiedName is null.

Method Details

isAccessible

public boolean isAccessible(Locale locale)

Checking whether the resource is accessible in given locale. That does not necessary means that the resource is available in exactly this language when there is a default resource.

Parameters:

locale - The locale you want be check.

Returns:

true if there is a resource bundle could be found for the given locale

See Also:

• ResourceBundle.getBundle(String)

getString

public String getString(String key,
 Locale locale,
 Object... replacements)

Try to load the resource bundle in given locale and searches for the given key. This method also replaces the replacement parameters in the found message by using the MessageFormat.

Parameters:

key - The key of the message

locale - the locale of the message

replacements - optional replacement parameters

Returns:

the message for the key in specified locale

Throws:

MissingResourceException - if the resource or the specified key is not found

See Also:

• ResourceBundle.getBundle(String, Locale, ClassLoader)
• Format.format(Object)

getString

public String getString(String key,
 Locale locale)

Try to load the resource bundle in given locale and searches for the given key.

Parameters:

key - The key of the message

locale - the locale of the message

Returns:

the message for the key in specified locale

Throws:

MissingResourceException - if the resource or the specified key is not found

See Also:

• ResourceBundle.getBundle(String, Locale, ClassLoader)

getString

public String getString(String key,
 Object... replacements)

Try to load the resource bundle in the jvm's default language and searches for the given key. This method also replaces the replacement parameters in the found message by using the MessageFormat.

Parameters:

key - The key of the message

replacements - optional replacement parameters

Returns:

the message for the key in specified locale

Throws:

MissingResourceException - if the resource or the specified key is not found

See Also:

• ResourceBundle.getBundle(String, Locale, ClassLoader)
• Format.format(Object)

getString

public String getString(String key)

Try to load the resource bundle in the jvm's default language and searches for the given key.

Parameters:

key - The key of the message

Returns:

the message for the key in specified locale

Throws:

MissingResourceException - if the resource or the specified key is not found

See Also:

• ResourceBundle.getBundle(String, Locale, ClassLoader)