From efb64e003c7c2df5317566bbf3fd01e62162f1dc Mon Sep 17 00:00:00 2001 From: =?utf8?q?David=20=E2=80=98Bombe=E2=80=99=20Roden?= Date: Mon, 23 Jun 2008 00:49:43 +0200 Subject: [PATCH] add javadoc --- src/de/todesbaum/jsite/i18n/I18n.java | 38 +++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/src/de/todesbaum/jsite/i18n/I18n.java b/src/de/todesbaum/jsite/i18n/I18n.java index fe7293d..1194473 100644 --- a/src/de/todesbaum/jsite/i18n/I18n.java +++ b/src/de/todesbaum/jsite/i18n/I18n.java @@ -24,13 +24,23 @@ import java.util.MissingResourceException; import java.util.ResourceBundle; /** + * Maps i18n keys to translated texts, depending on a current locale. + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ public class I18n { + /** The default locale, English. */ private static Locale defaultLocale = new Locale("en"); + + /** The current locale. */ private static Locale currentLocale; + /** + * Returns the currently set locale. + * + * @return The current locale + */ public static Locale getLocale() { if (currentLocale == null) { currentLocale = Locale.getDefault(); @@ -38,19 +48,47 @@ public class I18n { return currentLocale; } + /** + * Sets the current locale. + * + * @param locale + * The new current locale + */ public static void setLocale(Locale locale) { currentLocale = locale; Locale.setDefault(locale); } + /** + * Returns the resource bundle for the current locale. + * + * @return The resource bundle for the current locale + */ public static ResourceBundle getResourceBundle() { return getResourceBundle(getLocale()); } + /** + * Returns the resource bundle for the given locale. + * + * @param locale + * The locale to get the resource bundle for + * @return The resource bundle for the given locale + */ public static ResourceBundle getResourceBundle(Locale locale) { return ResourceBundle.getBundle("de.todesbaum.jsite.i18n.jSite", locale); } + /** + * Retrieves a translated text for the given i18n key. If the resource + * bundle for the current locale does not have a translation for the given + * key, the default locale is tried. If that fails, the key is returned. + * + * @param key + * The key to get the translation for + * @return The translated value, or the key itself if not translation can be + * found + */ public static String getMessage(String key) { try { return getResourceBundle().getString(key); -- 2.7.4