es.prodevelop.pui9.messages.PuiMessagesRegistry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of es.prodevelop.pui9.utils Show documentation
Multiple utilities for PUI9 (Gson, CSV, Exceptions...)
The newest version!
package es.prodevelop.pui9.messages;

import java.util.Arrays;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.Locale;
import java.util.Map;
import java.util.MissingResourceException;
import java.util.ResourceBundle;

import es.prodevelop.pui9.utils.PuiLanguage;

/**
 * A Registry class to contain all the internationalization strings of the
 * server. All the "Message" classes should use this Registry to register its
 * messages and use them later
 * 
 * @author Marc Gil - [email protected]
 */
public class PuiMessagesRegistry {

	private static PuiMessagesRegistry singleton;

	public static PuiMessagesRegistry getSingleton() {
		if (singleton == null) {
			singleton = new PuiMessagesRegistry();
		}
		return singleton;
	}

	private final Map> map = new LinkedHashMap<>();
	private String[] availableLanguages = { "es", "en", "ca", "fr" };
	private PuiLanguage defaultLanguage = PuiLanguage.DEFAULT_LANG;

	private PuiMessagesRegistry() {
	}

	/**
	 * Set the available languages of the application
	 * 
	 * @param langs The available languages
	 */
	public void setAvailableLanguages(String... langs) {
		availableLanguages = langs;

		synchronized (map) {
			// remove the languages that will not available
			for (Iterator it = map.keySet().iterator(); it.hasNext();) {
				if (!Arrays.asList(availableLanguages).contains(it.next())) {
					it.remove();
				}
			}

			// add the new available languages
			for (String lang : availableLanguages) {
				map.computeIfAbsent(lang, l -> new LinkedHashMap<>());
				Map oneLang = map.values().iterator().next();
				for (String baseMap : oneLang.keySet()) {
					addFileMessages(lang, baseMap);
				}
			}
		}
	}

	/**
	 * Set the default language of the application
	 * 
	 * @param lang The default language
	 */
	public void setDefaultLanguage(String lang) {
		defaultLanguage = new PuiLanguage(lang);
	}

	/**
	 * Register a new file of properties
	 * 
	 * @param baseName The base name to search the messages
	 */
	public void registerMessages(String baseName) {
		if (baseName == null) {
			throw new IllegalArgumentException("baseName parameter cannot be null");
		}
		for (String lang : availableLanguages) {
			addFileMessages(lang, baseName);
		}
	}

	/**
	 * Add a new file of properties for the given language
	 * 
	 * @param lang     The language of the file to be added
	 * @param baseName The base name of the filt to be added
	 */
	private void addFileMessages(String lang, String baseName) {
		synchronized (map) {
			try {
				if (!map.containsKey(lang)) {
					map.put(lang, new LinkedHashMap<>());
				}
				map.get(lang).put(baseName, ResourceBundle.getBundle(baseName, new Locale(lang)));
			} catch (MissingResourceException e) {
				map.get(lang).put(baseName,
						ResourceBundle.getBundle(baseName, new Locale(defaultLanguage.getIsocode())));
			}
		}
	}

	/**
	 * Get the message with the given key from the given base name file
	 * 
	 * @param baseName The base Name of the namespace to search for the key
	 * @param key      The key of the message to be searched
	 * @return The message
	 */
	public String getString(String baseName, String key) {
		return getString(baseName, defaultLanguage, key);
	}

	/**
	 * Get the message with the given key from the given base name file with the
	 * selected language
	 * 
	 * @param baseName The base Name of the namespace to search for the key
	 * @param lang     The desired language for the message
	 * @param key      The key of the message to be searched
	 * @return The message
	 */
	public String getString(String baseName, PuiLanguage lang, String key) {
		if (baseName == null) {
			throw new IllegalArgumentException("baseName parameter cannot be null");
		}

		if (key == null) {
			return "";
		}

		synchronized (map) {
			if (lang == null || !map.containsKey(lang.getIsocode())) {
				lang = defaultLanguage;
			}

			try {
				if (map.get(lang.getIsocode()).containsKey(baseName)) {
					return map.get(lang.getIsocode()).get(baseName).getString(key);
				} else {
					return null;
				}
			} catch (MissingResourceException e) {
				return null;
			}
		}
	}

	/**
	 * Get the message of the given key for the given Language
	 * 
	 * @param lang The required language
	 * @param key  The key of the message
	 * @return The message
	 */
	public String getString(PuiLanguage lang, String key) {
		if (key == null) {
			return "";
		}

		synchronized (map) {
			if (lang == null || !map.containsKey(lang.getIsocode())) {
				lang = defaultLanguage;
			}

			String val = null;
			for (ResourceBundle rb : map.get(lang.getIsocode()).values()) {
				try {
					val = rb.getString(key);
					break;
				} catch (MissingResourceException e) {
					// do nothing, continue with following resource bundle
				}
			}

			return val;
		}
	}

}