1 /** 2 * This file Copyright (c) 2003-2013 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 * @version $Id$ 52 */ 53 54 public abstract class AbstractMessagesImpl implements Messages { 55 56 protected Logger log = LoggerFactory.getLogger(AbstractMessagesImpl.class); 57 58 /** 59 * Name of the javascript object used to make the messages public to the javascripts. 60 */ 61 public static final String JS_OBJECTNAME = "mgnlMessages"; 62 63 /** 64 * The name of the bundle. 65 */ 66 protected String basename = MessagesManager.DEFAULT_BASENAME; 67 68 /** 69 * The current locale. 70 */ 71 protected Locale locale; 72 73 /** 74 * The current bundle. Subclasses will overwrite getBundle(). 75 */ 76 protected ResourceBundle bundle; 77 78 protected AbstractMessagesImpl(String basename, Locale locale) { 79 this.locale = locale; 80 this.basename = basename; 81 } 82 83 /** 84 * Returns the current locale. 85 */ 86 @Override 87 public Locale getLocale() { 88 return locale; 89 } 90 91 /** 92 * If no basename is provided this method returns DEFAULT_BASENAME. 93 * @return current basename 94 */ 95 @Override 96 public String getBasename() { 97 return basename; 98 } 99 100 /** 101 * Replace the {n} parameters in the string. 102 * @see java.text.MessageFormat#format(String, Object[]) 103 */ 104 @Override 105 public String get(String key, Object[] args) { 106 return MessageFormat.format(get(key), args); 107 } 108 109 /** 110 * You can provide a default value if the key is not found. 111 * @param key key 112 * @param defaultMsg the default message 113 * @return the message 114 */ 115 @Override 116 public String getWithDefault(String key, String defaultMsg) { 117 String msg = get(key); 118 if (msg.startsWith("???")) { 119 msg = defaultMsg; 120 } 121 return msg; 122 } 123 124 /** 125 * With default value and replacement strings. 126 * @param key key 127 * @param args replacement strings 128 * @param defaultMsg default message 129 * @return message 130 */ 131 @Override 132 public String getWithDefault(String key, Object[] args, String defaultMsg) { 133 return MessageFormat.format(getWithDefault(key, defaultMsg), args); 134 } 135 136 /** 137 * True if the basename and the locale are the same. 138 */ 139 @Override 140 public boolean equals(Object arg0) { 141 if (arg0 == null || !(arg0 instanceof AbstractMessagesImpl)) { 142 return false; 143 } 144 return StringUtils.equals(((AbstractMessagesImpl) arg0).basename, this.basename) 145 && this.locale.equals(((AbstractMessagesImpl) arg0).locale); 146 } 147 148 /** 149 * Nice string. 150 */ 151 @Override 152 public String toString() { 153 return this.basename + "(" + this.locale + ")"; 154 } 155 156 }