X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Futil%2FMessageManager.java;h=435950630d1dd728d88db2a63553951dfed4aca0;hb=816c0cb06ba40008364b66c452895a211e61d5d5;hp=8adac34e537ac577643b48f05c55c3b814e21624;hpb=47168f025aefdaa044802bd5f8f510ffe43a4808;p=jalview.git

diff --git a/src/jalview/util/MessageManager.java b/src/jalview/util/MessageManager.java
index 8adac34..4359506 100644
--- a/src/jalview/util/MessageManager.java
+++ b/src/jalview/util/MessageManager.java
@@ -1,6 +1,6 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
- * Copyright (C) 2014 The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
@@ -31,77 +31,137 @@ import java.util.logging.Logger;
  * @author David Roldan Martinez
  * @author Thomas Abeel
  * 
- *
+ * 
  */
-public class MessageManager {
+public class MessageManager
+{
+  private static ResourceBundle rb;
 
-	private static ResourceBundle rb;    
-		
-	private static Logger log=Logger.getLogger(MessageManager.class.getCanonicalName());
-	
-	private static Locale loc;
-	
-	
-	
-    static{
-      try {
-    	/* Localize Java dialogs */
-        loc = Locale.getDefault();
-    	// Locale.setDefault(loc);
-    	/* Getting messages for GV */
-    	log.info("Getting messages for lang: "+loc);
-        rb = ResourceBundle.getBundle("lang.Messages", loc);
-        if (log.isLoggable(Level.FINEST)) {
-          // this might take a while, so we only do it if it will be shown
-          log.finest("Language keys: "+rb.keySet());
-        }
-      } catch (Exception q) {
-        log.warning("Exception when initting Locale for i18n messages\n"+q.getMessage());
-        q.printStackTrace();
-      }
-      catch (Error v)
+  private static Logger log = Logger
+          .getLogger(MessageManager.class.getCanonicalName());
+
+  private static Locale loc;
+
+  static
+  {
+    try
+    {
+      /* Localize Java dialogs */
+      loc = Locale.getDefault();
+      // Locale.setDefault(loc);
+      /* Getting messages for GV */
+      log.info("Getting messages for lang: " + loc);
+      rb = ResourceBundle.getBundle("lang.Messages", loc);
+      if (log.isLoggable(Level.FINEST))
       {
-        log.warning("Error when initting Locale for i18n messages\n"+v.getMessage());
-        v.printStackTrace();
+        // this might take a while, so we only do it if it will be shown
+        log.finest("Language keys: " + rb.keySet());
       }
-      
-     
+    } catch (Exception q)
+    {
+      log.warning("Exception when initting Locale for i18n messages\n"
+              + q.getMessage());
+      q.printStackTrace();
+    } catch (Error v)
+    {
+      log.warning("Error when initting Locale for i18n messages\n"
+              + v.getMessage());
+      v.printStackTrace();
     }
-    
-    public static String getString(String key){
-    	String value = "[missing key] " + key;
-    	try{
-    		value = rb.getString(key);
-    	}catch(Exception e){
-    	  log.warning("I18N missing: "+loc+"\t"+key);
-    	}
-    	return value;
+
+  }
+
+  /**
+   * 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;
+    try
+    {
+      value = rb.getString(key);
+    } catch (Exception e)
+    {
+      log.warning("I18N missing: " + loc + "\t" + key);
     }
-    
-	public static Locale getLocale() {
-		return loc;
-	}
-	public static String formatMessage(String key, Object... params){
-		return MessageFormat.format(rb.getString(key), (Object[]) params);
-	}
+    return value;
+  }
+
+  public static Locale getLocale()
+  {
+    return loc;
+  }
 
   /**
-   * 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 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)
+  {
+    try
+    {
+      return MessageFormat.format(rb.getString(key), params);
+    } catch (Exception e)
+    {
+      log.warning("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 formatMessage(key, (Object[]) params);
+  }
+
+  /**
+   * 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
    * @return
    */
   public static String getStringOrReturn(String keyroot, String name)
   {
-    String smkey = keyroot
-            + name.toLowerCase().replaceAll(" ", "");
-    try {
-      name = rb.getString(smkey); 
-    }
-    catch (Exception x) {
-      log.finest("I18N missing key with root "+keyroot+": "+loc+"\t"+smkey);
+    String smkey = keyroot + name.toLowerCase().replaceAll(" ", "");
+    try
+    {
+      name = rb.getString(smkey);
+    } catch (Exception x)
+    {
+      log.finest("I18N missing key with root " + keyroot + ": " + loc + "\t"
+              + smkey);
     }
     return name;
   }