br.com.caelum.vraptor.boilerplate.i18n.MessageBundle Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vraptor-boilerplate-utils Show documentation
VRaptor Boilerplate utility classes.
The newest version!
package br.com.caelum.vraptor.boilerplate.i18n;

import java.text.MessageFormat;
import java.util.Enumeration;
import java.util.Locale;
import java.util.Map;
import java.util.MissingResourceException;
import java.util.PropertyResourceBundle;

import br.com.caelum.vraptor.boilerplate.util.GeneralUtils;

/**
 * A bundle of internationalized messages.
 * @author Renato R. R. de Oliveira
 *
 */
public class MessageBundle {
	/** Lolcale para um objeto definido com uma lingua. */
	private final Locale locale;
	/** Bundle com mensagens traduzidas. */
	private final PropertyResourceBundle bundle;
	/** Mapa com overlays de mensagens ao bundle padrão. */
	private Map overlay;
	
	public MessageBundle(MessageBundleConfig config) {
		this.locale = config.getDefaultLocale();
		this.overlay = null;
		this.bundle = (PropertyResourceBundle) PropertyResourceBundle.getBundle(config.getBundleResourceName(), this.locale);
	}
	public MessageBundle(Locale locale, String bundleResourceName) {
		this.locale = locale;
		this.overlay = null;
		this.bundle = (PropertyResourceBundle) PropertyResourceBundle.getBundle(bundleResourceName, this.locale);
	}
	@Deprecated
	protected MessageBundle() { this(null); }
	
	/**
	 * Define um mapa de overlays de mensagens.
	 * @param overlay Mapa contendo mensagens na forma chave-valor.
	 */
	public void setOverlay(Map overlay) {
		this.overlay = overlay;
	}
	
	/**
	 * Recupera uma mensagem do mapa de overlay (se houver).
	 * @param key Chave da mensagem a ser recuperada.
	 * @return Mensagem contida no overlay.
	 */
	private String getOverlayMessage(String key) {
		if ((this.overlay == null) || GeneralUtils.isEmpty(key))
			return null;
		return this.overlay.get(key);
	}
	
	/**
	 * Obt�m uma mensagem dada a chave.
	 * @param key Chave no arquivo de properties.
	 * @return Texto referente a chave passada.
	 */
	public String getMessage(String key) {
		try {
			String overlayed = this.getOverlayMessage(key);
			if (!GeneralUtils.isEmpty(overlayed)) {
				return overlayed;
			}
			return this.bundle.getString(key);
		} catch (MissingResourceException ex) {
			return "???"+key+"???";
		}
	}
	
	/**
	 * Retorna uma mensagem formatada utilizando o MessageFormat.
	 * @param key Chave da mesnagem.
	 * @param args Parametros a serem inseridos na mensagem.
	 * @return Mensagem formatada inserindo os argumentos no template estático obtivdo do arquivo de propriedades.
	 */
	public String formatMessage(String key, Object[] args) {
		try {
			String raw = this.getMessage(key);
			return MessageFormat.format(raw, args);
		} catch (MissingResourceException ex) {
			return "???!"+key+"!???";
		}
	}
	
	/**
	 * Obtém uma string com um mapa em JSON de todas as mensagens.
	 */
	public String getJSONMessages() {
		StringBuilder builder = new StringBuilder();
		builder.append("{");
		
		boolean first = true;
		Enumeration keys = this.bundle.getKeys();
		while (keys.hasMoreElements()) {
			if (!first)
				builder.append(",");
			else
				first = false;
			String key = keys.nextElement();
			String value = this.getMessage(key);
			String escaped = value.replaceAll("\\'", "\\\\'");
			builder.append("'").append(key).append("':'").append(escaped).append("'");
		}
		
		builder.append("}");
		return builder.toString();
	}
}