2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
23 import java.text.MessageFormat;
24 import java.util.HashSet;
25 import java.util.Locale;
26 import java.util.ResourceBundle;
27 import java.util.ResourceBundle.Control;
30 import org.apache.log4j.Logger;
34 * @author David Roldan Martinez
35 * @author Thomas Abeel
39 public class MessageManager
41 private static ResourceBundle rb;
43 // BH 2018 switched to org.apache.llog4j.Logger
44 private static Logger log = Logger
45 .getLogger(MessageManager.class.getCanonicalName());
47 private static Locale loc;
49 private static Set<String> reportedMissing = new HashSet<>();
55 /* Localize Java dialogs */
56 loc = Locale.getDefault();
57 // Locale.setDefault(loc);
58 /* Getting messages for GV */
59 log.info("Getting messages for lang: " + loc);
60 rb = ResourceBundle.getBundle("lang.Messages", Platform.getLocaleOrNone(loc), Control.getControl(Control.FORMAT_PROPERTIES));
61 // if (log.isLoggable(Level.FINEST))
63 // // this might take a while, so we only do it if it will be shown
64 // log.info("Language keys: " + rb.keySet()); // was FINEST
68 log.warn("Exception when initting Locale for i18n messages\n"
73 log.warn("Error when initting Locale for i18n messages\n"
81 * Returns the resource bundle text for the given key, or if not found, the
82 * key prefixed by "[missing key]"
87 public static String getString(String key)
89 String value = "[missing key] " + key;
92 value = rb.getString(key);
95 String msg = "I18N missing: " + loc + "\t" + key;
101 public static Locale getLocale()
107 * Returns the resource bundle text for the given key, with tokens {@code {0},
108 * {1} etc replaced by the supplied parameters. If the key is not found,
109 * returns the key and values prefixed by "[missing key]"
115 public static String formatMessage(String key, Object... params)
119 return MessageFormat.format(rb.getString(key), params);
120 } catch (Exception e)
122 log.warn("I18N missing: " + loc + "\t" + key);
124 String value = "[missing key] " + key + "";
125 for (Object p : params)
127 value += " '" + p.toString() + "'";
133 * Returns the resource bundle text for the given key, with tokens {@code {0},
134 * {1} etc replaced by the supplied parameters. If the key is not found,
135 * returns the key and values prefixed by "[missing key]"
141 public static String formatMessage(String key, String[] params)
143 return formatMessage(key, (Object[]) params);
147 * Returns resource bundle text given a root and a human-readable(ish) name
148 * that when combined might resolve to an i18n string. {@code name} is forced
149 * to lower case, with any spaces removed, and concatenated to {@code keyroot}
150 * to form a lookup key.
152 * If the key doesn't resolve, then {@code name} is returned.
154 * Use this for programmatically constructed keys that might have a human
155 * readable alternative used in the program (e.g. BLOSUM62 and
156 * label.score_blosum62).
162 public static String getStringOrReturn(String keyroot, String name)
164 String smkey = keyroot + name.toLowerCase().replaceAll(" ", "");
167 name = rb.getString(smkey);
168 } catch (Exception x)
170 String msg = "I18N missing key with root " + keyroot + ": " + loc + "\t"
172 logWarning(smkey, msg);
178 * Logs missing keys (each key once only per run)
183 private static void logWarning(String key, String msg)
185 if (!reportedMissing.contains(key))
187 reportedMissing.add(key);