org.apache.wiki.i18n

Class InternationalizationManager

java.lang.Object

org.apache.wiki.i18n.InternationalizationManager

public class InternationalizationManager
extends Object

Manages all internationalization in JSPWiki.

Since:

2.6

Field Summary

Fields

Modifier and Type	Field and Description
static String	CORE_BUNDLE The name of the ResourceBundle which contains any and all JSPWiki core resource strings.
static String	DEF_TEMPLATE The name of the ResourceBundle which contains any and all JSPWiki default templates resource strings.

Constructor Summary

Constructors

Constructor and Description
InternationalizationManager(WikiEngine engine) Constructs a new InternationalizationManager.

Method Summary

Modifier and Type	Method and Description
String	get(String key) Returns a String from the CORE_BUNDLE using English as the default locale.
String	get(String bundle, Locale locale, String key) If you are too lazy to open your own bundle, use this method to get a string simply from a bundle.
String	get(String bundle, Locale locale, String key, Object... args) Obtain a parameterized String from the bundle.
ResourceBundle	getBundle(String bundle, Locale locale) Finds a resource bundle.

Methods inherited from class java.lang.Object

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

Field Detail

CORE_BUNDLE

public static final String CORE_BUNDLE

The name of the ResourceBundle which contains any and all JSPWiki core resource strings. It's value is "CoreResources".

See Also:

Constant Field Values

DEF_TEMPLATE

public static final String DEF_TEMPLATE

The name of the ResourceBundle which contains any and all JSPWiki default templates resource strings. It's value is "templates.default".

See Also:

Constant Field Values

Constructor Detail

InternationalizationManager

public InternationalizationManager(WikiEngine engine)

Constructs a new InternationalizationManager.

Parameters:

engine - To which engine this belongs to

Method Detail

get

public String get(String key)
           throws MissingResourceException

Returns a String from the CORE_BUNDLE using English as the default locale.

Parameters:

key - Key to find

Returns:

The English string

Throws:

MissingResourceException - If there is no such key

getBundle

public ResourceBundle getBundle(String bundle,
                                Locale locale)
                         throws MissingResourceException

Finds a resource bundle.

Parameters:

bundle - The ResourceBundle to find. Must exist.

locale - The Locale to use. Set to null to get the default locale.

Returns:

A localized string

Throws:

MissingResourceException - If the key cannot be located at all, even from the default locale.

get

public String get(String bundle,
                  Locale locale,
                  String key)
           throws MissingResourceException

If you are too lazy to open your own bundle, use this method to get a string simply from a bundle.

Parameters:

bundle - Which bundle the string is in

locale - Locale to use - null for default

key - Which key to use.

Returns:

A localized string (or from the default language, if not found)

Throws:

MissingResourceException - If the key cannot be located at all, even from the default locale.

get

public String get(String bundle,
                  Locale locale,
                  String key,
                  Object... args)
           throws MissingResourceException

Obtain a parameterized String from the bundle.

Parameters:

bundle - Which bundle the string is in

locale - Locale to use - null for default

key - Which key to use.

args - parameters to insert in the String.

Returns:

A localized string (or from the default language, if not found)

Throws:

MissingResourceException - If the key cannot be located at all, even from the default locale.