X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Futil%2FMessageManager.java;h=acd45910a5670fcf43802114bb78b80c1afcb190;hb=08bb9485b737ca84f223ea4ba92fc0873387fc0f;hp=1cfe0c67543ce48258f6635d31d8783bc99e1d03;hpb=507f8f9e119ce89ba04aea3b3d814cbe58f3d686;p=jalview.git

diff --git a/src/jalview/util/MessageManager.java b/src/jalview/util/MessageManager.java
index 1cfe0c6..acd4591 100644
--- a/src/jalview/util/MessageManager.java
+++ b/src/jalview/util/MessageManager.java
@@ -21,13 +21,13 @@
 package jalview.util;
 
 import java.text.MessageFormat;
+import java.util.HashSet;
 import java.util.Locale;
 import java.util.ResourceBundle;
 import java.util.ResourceBundle.Control;
-//import java.util.logging.Level;
-//import java.util.logging.Logger;
+import java.util.Set;
 
-import org.apache.log4j.Logger;
+import jalview.log.JLoggerLog4j;
 
 /**
  * 
@@ -38,16 +38,15 @@ import org.apache.log4j.Logger;
  */
 public class MessageManager
 {
-
-  // BH 2018 switched to org.apache.llog4j.Logger
-
   private static ResourceBundle rb;
 
-  private static Logger log = Logger
+  private static JLoggerLog4j log = JLoggerLog4j
           .getLogger(MessageManager.class.getCanonicalName());
 
   private static Locale loc;
 
+  private static Set<String> reportedMissing = new HashSet<>();
+
   static
   {
     try
@@ -78,6 +77,13 @@ public class MessageManager
 
   }
 
+  /**
+   * Returns the resource bundle text for the given key, or if not found, the
+   * key prefixed by "[missing key]"
+   * 
+   * @param key
+   * @return
+   */
   public static String getString(String key)
   {
     String value = "[missing key] " + key;
@@ -86,7 +92,8 @@ public class MessageManager
       value = rb.getString(key);
     } catch (Exception e)
     {
-      log.warn("I18N missing: " + loc + "\t" + key);
+      String msg = "I18N missing: " + loc + "\t" + key;
+      logWarning(key, msg);
     }
     return value;
   }
@@ -96,22 +103,57 @@ public class MessageManager
     return loc;
   }
 
+  /**
+   * Returns the resource bundle text for the given key, with tokens {@code {0},
+   * {1} etc replaced by the supplied parameters. If the key is not found,
+   * returns the key and values prefixed by "[missing key]"
+   * 
+   * @param key
+   * 
+   * @return
+   */
   public static String formatMessage(String key, Object... params)
   {
-    return MessageFormat.format(rb.getString(key), params);
+    try
+    {
+      return MessageFormat.format(rb.getString(key), params);
+    } catch (Exception e)
+    {
+      log.warn("I18N missing: " + loc + "\t" + key);
+    }
+    String value = "[missing key] " + key + "";
+    for (Object p : params)
+    {
+      value += " '" + p.toString() + "'";
+    }
+    return value;
   }
 
+  /**
+   * Returns the resource bundle text for the given key, with tokens {@code {0},
+   * {1} etc replaced by the supplied parameters. If the key is not found,
+   * returns the key and values prefixed by "[missing key]"
+   * 
+   * @param key
+   * 
+   * @return
+   */
   public static String formatMessage(String key, String[] params)
   {
-    return MessageFormat.format(rb.getString(key), (Object[]) params);
+    return formatMessage(key, (Object[]) params);
   }
 
   /**
-   * lookup and return a key given a root and a human-readable(ish) name that
-   * when combined might resolve to an i18n string. If the key doesn't resolve,
-   * then name is returned.if the key doesn't exist. Use this for
-   * programatically constructed keys that have have a human readable
-   * alternative used in the program (e.g. BLOSUM62 and label.score_blosum62)
+   * Returns resource bundle text given a root and a human-readable(ish) name
+   * that when combined might resolve to an i18n string. {@code name} is forced
+   * to lower case, with any spaces removed, and concatenated to {@code keyroot}
+   * to form a lookup key.
+   * <p>
+   * If the key doesn't resolve, then {@code name} is returned.
+   * <p>
+   * Use this for programmatically constructed keys that might have a human
+   * readable alternative used in the program (e.g. BLOSUM62 and
+   * label.score_blosum62).
    * 
    * @param keyroot
    * @param name
@@ -119,15 +161,32 @@ public class MessageManager
    */
   public static String getStringOrReturn(String keyroot, String name)
   {
-    String smkey = keyroot + name.toLowerCase().replaceAll(" ", "");
+    String smkey = keyroot
+            + name.toLowerCase(Locale.ROOT).replaceAll(" ", "");
     try
     {
       name = rb.getString(smkey);
     } catch (Exception x)
     {
-      log.info("I18N missing key with root " + keyroot + ": " + loc + "\t"
-              + smkey); // was FINEST
+      String msg = "I18N missing key with root " + keyroot + ": " + loc
+              + "\t" + smkey;
+      logWarning(smkey, msg);
     }
     return name;
   }
+
+  /**
+   * Logs missing keys (each key once only per run)
+   * 
+   * @param key
+   * @param msg
+   */
+  private static void logWarning(String key, String msg)
+  {
+    if (!reportedMissing.contains(key))
+    {
+      reportedMissing.add(key);
+      log.info(msg);
+    }
+  }
 }