Fix up all file headers.

[jSite.git] / src / de / todesbaum / jsite / i18n / I18n.java

diff --git a/src/de/todesbaum/jsite/i18n/I18n.java b/src/de/todesbaum/jsite/i18n/I18n.java
index 38a6916..4c1cceb 100644 (file)
--- a/src/de/todesbaum/jsite/i18n/I18n.java
+++ b/src/de/todesbaum/jsite/i18n/I18n.java
@@ -1,6 +1,5 @@
 /*
- * jSite - a tool for uploading websites into Freenet
- * Copyright (C) 2006 David Roden
+ * jSite - I18n.java - Copyright © 2006–2012 David Roden
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -20,37 +19,85 @@
 package de.todesbaum.jsite.i18n;
 
 import java.util.Locale;
+import java.util.MissingResourceException;
 import java.util.ResourceBundle;
 
 /**
- * @author David Roden <droden@gmail.com>
- * @version $Id: I18n.java 355 2006-03-24 15:04:11Z bombe $
+ * 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)
+               if (currentLocale == null) {
                        currentLocale = Locale.getDefault();
+               }
                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) {
-               return getResourceBundle().getString(key);
+               try {
+                       return getResourceBundle().getString(key);
+               } catch (MissingResourceException mre1) {
+                       try {
+                               return getResourceBundle(defaultLocale).getString(key);
+                       } catch (MissingResourceException mre2) {
+                               return key;
+                       }
+               }
        }
 
 }