1 /** 2 * This file Copyright (c) 2003-2011 Magnolia International 3 * Ltd. (http://www.magnolia-cms.com). All rights reserved. 4 * 5 * 6 * This file is dual-licensed under both the Magnolia 7 * Network Agreement and the GNU General Public License. 8 * You may elect to use one or the other of these licenses. 9 * 10 * This file is distributed in the hope that it will be 11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the 12 * implied warranty of MERCHANTABILITY or FITNESS FOR A 13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT. 14 * Redistribution, except as permitted by whichever of the GPL 15 * or MNA you select, is prohibited. 16 * 17 * 1. For the GPL license (GPL), you can redistribute and/or 18 * modify this file under the terms of the GNU General 19 * Public License, Version 3, as published by the Free Software 20 * Foundation. You should have received a copy of the GNU 21 * General Public License, Version 3 along with this program; 22 * if not, write to the Free Software Foundation, Inc., 51 23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 24 * 25 * 2. For the Magnolia Network Agreement (MNA), this file 26 * and the accompanying materials are made available under the 27 * terms of the MNA which accompanies this distribution, and 28 * is available at http://www.magnolia-cms.com/mna.html 29 * 30 * Any modifications to this file must keep this entire header 31 * intact. 32 * 33 */ 34 package info.magnolia.cms.i18n; 35 36 import java.text.MessageFormat; 37 import java.util.Locale; 38 import java.util.ResourceBundle; 39 40 import org.apache.commons.lang.StringUtils; 41 import org.slf4j.Logger; 42 import org.slf4j.LoggerFactory; 43 44 45 /** 46 * Provides localized strings. You should uses the ContextMessages class if you can provide a request object. 47 * AbstractMessagesImpl will do the job as good as possible without to know the session (user) and all the other 48 * contextual things. Endusers will use the MessageManager to resolve messages. 49 * @author Philipp Bracher 50 */ 51 52 public abstract class AbstractMessagesImpl implements Messages { 53 54 protected Logger log = LoggerFactory.getLogger(AbstractMessagesImpl.class); 55 56 /** 57 * Name of the javascript object used to make the messages public to the javascripts. 58 */ 59 public static final String JS_OBJECTNAME = "mgnlMessages"; //$NON-NLS-1$ 60 61 /** 62 * The name of the bundle. 63 */ 64 protected String basename = MessagesManager.DEFAULT_BASENAME; 65 66 /** 67 * The current locale. 68 */ 69 protected Locale locale; 70 71 /** 72 * The current bundle. Subclasses will overwrite getBundle(). 73 */ 74 protected ResourceBundle bundle; 75 76 protected AbstractMessagesImpl(String basename, Locale locale) { 77 this.locale = locale; 78 this.basename = basename; 79 } 80 81 /** 82 * Returns the current locale. 83 */ 84 public Locale getLocale() { 85 return locale; 86 } 87 88 /** 89 * If no basename is provided this method returns DEFAULT_BASENAME. 90 * @return current basename 91 */ 92 public String getBasename() { 93 return basename; 94 } 95 96 /** 97 * Replace the {n} parameters in the string. 98 * @see java.text.MessageFormat#format(String, Object[]) 99 */ 100 public String get(String key, Object[] args) { 101 return MessageFormat.format(get(key), args); 102 } 103 104 /** 105 * You can provide a default value if the key is not found. 106 * @param key key 107 * @param defaultMsg the default message 108 * @return the message 109 */ 110 public String getWithDefault(String key, String defaultMsg) { 111 String msg = get(key); 112 if (msg.startsWith("???")) { //$NON-NLS-1$ 113 msg = defaultMsg; 114 } 115 return msg; 116 } 117 118 /** 119 * With default value and replacement strings. 120 * @param key key 121 * @param args replacement strings 122 * @param defaultMsg default message 123 * @return message 124 */ 125 public String getWithDefault(String key, Object[] args, String defaultMsg) { 126 return MessageFormat.format(getWithDefault(key, defaultMsg), args); 127 } 128 129 /** 130 * True if the basename and the locale are the same. 131 */ 132 public boolean equals(Object arg0) { 133 return StringUtils.equals(((AbstractMessagesImpl) arg0).basename, this.basename) 134 && this.locale.equals(((AbstractMessagesImpl) arg0).locale); 135 } 136 137 /** 138 * Nice string. 139 */ 140 public String toString() { 141 return this.basename + "(" + this.locale + ")"; 142 } 143 144 }