JAL-1807 explicit imports (jalview.appletgui)
[jalview.git] / src / jalview / util / Format.java
index 9aeb8a6..1c8e444 100755 (executable)
@@ -1,19 +1,22 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
- * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * Jalview is free software: you can redistribute it and/or
  * modify it under the terms of the GNU General Public License 
- * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
  *  
  * Jalview is distributed in the hope that it will be useful, but 
  * WITHOUT ANY WARRANTY; without even the implied warranty 
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
  * PURPOSE.  See the GNU General Public License for more details.
  * 
- * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 /**
  * A class for formatting numbers that follows printf conventions.
@@ -51,6 +54,8 @@ public class Format
 
   private char fmt; // one of cdeEfgGiosxXos
 
+  private final String formatString;
+
   /**
    * Creates a new Format object.
    * 
@@ -59,6 +64,7 @@ public class Format
    */
   public Format(String s)
   {
+    formatString = s;
     width = 0;
     precision = -1;
     pre = "";
@@ -303,9 +309,9 @@ public class Format
    * @param x
    *          the double to print
    */
-  public static void print(java.io.PrintStream s, String fmt, double x)
+  public static void printDouble(java.io.PrintStream s, String fmt, double x)
   {
-    s.print(new Format(fmt).form(x));
+    s.print(new Format(fmt).formDouble(x));
   }
 
   /**
@@ -318,9 +324,9 @@ public class Format
    * @param x
    *          the long to print
    */
-  public static void print(java.io.PrintStream s, String fmt, long x)
+  public static void printLong(java.io.PrintStream s, String fmt, long x)
   {
-    s.print(new Format(fmt).form(x));
+    s.print(new Format(fmt).formLong(x));
   }
 
   /**
@@ -333,9 +339,9 @@ public class Format
    * @param x
    *          the character to
    */
-  public static void print(java.io.PrintStream s, String fmt, char x)
+  public static void printChar(java.io.PrintStream s, String fmt, char x)
   {
-    s.print(new Format(fmt).form(x));
+    s.print(new Format(fmt).formChar(x));
   }
 
   /**
@@ -538,7 +544,7 @@ public class Format
    * @exception IllegalArgumentException
    *              if bad argument
    */
-  public String form(double x)
+  public String formDouble(double x)
   {
     String r;
 
@@ -578,7 +584,7 @@ public class Format
    *          the number to format
    * @return the formatted string
    */
-  public String form(long x)
+  public String formLong(long x)
   {
     String r;
     int s = 0;
@@ -619,11 +625,11 @@ public class Format
   /**
    * Formats a character into a string (like sprintf in C)
    * 
-   * @param x
+   * @param debounceTrap
    *          the value to format
    * @return the formatted string
    */
-  public String form(char c)
+  public String formChar(char c)
   {
     if (fmt != 'c')
     {
@@ -638,7 +644,7 @@ public class Format
   /**
    * Formats a string into a larger string (like sprintf in C)
    * 
-   * @param x
+   * @param debounceTrap
    *          the value to format
    * @return the formatted string
    */
@@ -935,4 +941,10 @@ public class Format
 
     return f + p.substring(p.length() - 3, p.length());
   }
+
+  @Override
+  public String toString()
+  {
+    return formatString;
+  }
 }