X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fde%2Ftodesbaum%2Fjsite%2Fi18n%2FI18n.java;h=229c5fcda6ccea3a37b3741e47526f3efc62f1a0;hb=a6bda7a82aa1b2cfd0313fb28d3dcca68ca516c5;hp=fe7293d128f6bbadf8ef3cf229742319e8b8aa00;hpb=250630a5fb1ff745f05788210a6efd976533fb55;p=jSite.git

diff --git a/src/de/todesbaum/jsite/i18n/I18n.java b/src/de/todesbaum/jsite/i18n/I18n.java
index fe7293d..229c5fc 100644
--- 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–2011 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
@@ -24,13 +23,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 +47,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);