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
42 // BH 2018 switched to org.apache.llog4j.Logger
44 private static ResourceBundle rb;
46 private final static Logger log = Logger
47 .getLogger(MessageManager.class.getCanonicalName());
49 private final static Locale loc;
51 private final static Set<String> reportedMissing = new HashSet<>();
55 loc = Locale.getDefault();
58 /* Getting messages for GV */
59 // BH 2020.0-6.05 using new Locale("") to avoid unnecessary check for "en"
60 // here; works in Java as well, but not implementing that.
61 log.info("Getting messages for lang: " + loc);
62 Control control = Control.getControl(Control.FORMAT_PROPERTIES);
63 rb = ResourceBundle.getBundle("lang.Messages",
64 Platform.getLocaleOrNone(loc),
66 // if (log.isLoggable(Level.FINEST))
68 // // this might take a while, so we only do it if it will be shown
69 // log.info("Language keys: " + rb.keySet()); // was FINEST
73 log.warn("Exception when initting Locale for i18n messages\n"
78 log.warn("Error when initting Locale for i18n messages\n"
85 public static String getString(String key)
87 String value = "[missing key] " + key;
90 value = rb.getString(key);
93 String msg = "I18N missing: " + loc + "\t" + key;
99 public static Locale getLocale()
104 public static String formatMessage(String key, Object... params)
106 return MessageFormat.format(getString(key), params);
109 public static String formatMessage(String key, String[] params)
111 return MessageFormat.format(getString(key), (Object[]) params);
115 * Looks up and returns a key given a root and a human-readable(ish) name that
116 * when combined might resolve to an i18n string. If the key doesn't resolve,
117 * then name is returned. Use this for programmatically constructed keys that
118 * have a human readable alternative used in the program (e.g. BLOSUM62 and
119 * label.score_blosum62).
125 public static String getStringOrReturn(String keyroot, String name)
127 String smkey = keyroot + name.toLowerCase().replaceAll(" ", "");
130 name = rb.getString(smkey);
131 } catch (Exception x)
133 String msg = "I18N missing key with root " + keyroot + ": " + loc + "\t"
135 logWarning(smkey, msg);
141 * Logs missing keys (each key once only per run)
146 private static void logWarning(String key, String msg)
148 if (!reportedMissing.contains(key))
150 reportedMissing.add(key);