jalview 2.5 release banner

[jalview.git] / src / jalview / util / Format.java

diff --git a/src/jalview/util/Format.java b/src/jalview/util/Format.java
index 49e4027..e217704 100755 (executable)
--- a/src/jalview/util/Format.java
+++ b/src/jalview/util/Format.java
@@ -1,20 +1,19 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1)
- * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
+ * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
  * 
- * This program 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 2
- * of the License, or (at your option) any later version.
+ * This file is part of Jalview.
  * 
- * This program 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.
+ * 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.
  * 
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ * 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/>.
  */
 /**
  * A class for formatting numbers that follows printf conventions.
@@ -56,7 +55,7 @@ public class Format
    * Creates a new Format object.
    * 
    * @param s
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public Format(String s)
   {
@@ -206,7 +205,7 @@ public class Format
     }
   }
 
-  /**
+/**
    * Formats the number following printf conventions. Main limitation: Can only
    * handle one format parameter at a time Use multiple Format objects to format
    * more than one number
@@ -301,11 +300,11 @@ public class Format
    * prints a formatted number following printf conventions
    * 
    * @param s
-   *                a PrintStream
+   *          a PrintStream
    * @param fmt
-   *                the format string
+   *          the format string
    * @param x
-   *                the double to print
+   *          the double to print
    */
   public static void print(java.io.PrintStream s, String fmt, double x)
   {
@@ -316,11 +315,11 @@ public class Format
    * prints a formatted number following printf conventions
    * 
    * @param s
-   *                a PrintStream
+   *          a PrintStream
    * @param fmt
-   *                the format string
+   *          the format string
    * @param x
-   *                the long to print
+   *          the long to print
    */
   public static void print(java.io.PrintStream s, String fmt, long x)
   {
@@ -331,11 +330,11 @@ public class Format
    * prints a formatted number following printf conventions
    * 
    * @param s
-   *                a PrintStream
+   *          a PrintStream
    * @param fmt
-   *                the format string
+   *          the format string
    * @param x
-   *                the character to
+   *          the character to
    */
   public static void print(java.io.PrintStream s, String fmt, char x)
   {
@@ -346,9 +345,9 @@ public class Format
    * prints a formatted number following printf conventions
    * 
    * @param s
-   *                a PrintStream, fmt the format string
+   *          a PrintStream, fmt the format string
    * @param x
-   *                a string that represents the digits to print
+   *          a string that represents the digits to print
    */
   public static void print(java.io.PrintStream s, String fmt, String x)
   {
@@ -359,7 +358,7 @@ public class Format
    * Converts a string of digits (decimal, octal or hex) to an integer
    * 
    * @param s
-   *                a string
+   *          a string
    * @return the numeric value of the prefix of s representing a base 10 integer
    */
   public static int atoi(String s)
@@ -371,7 +370,7 @@ public class Format
    * Converts a string of digits (decimal, octal or hex) to a long integer
    * 
    * @param s
-   *                a string
+   *          a string
    * @return the numeric value of the prefix of s representing a base 10 integer
    */
   public static long atol(String s)
@@ -405,9 +404,9 @@ public class Format
    * DOCUMENT ME!
    * 
    * @param s
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * @param base
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * 
    * @return DOCUMENT ME!
    */
@@ -463,7 +462,7 @@ public class Format
    * Converts a string of digits to an double
    * 
    * @param s
-   *                a string
+   *          a string
    */
   public static double atof(String s)
   {
@@ -537,10 +536,10 @@ public class Format
    * Formats a double into a string (like sprintf in C)
    * 
    * @param x
-   *                the number to format
+   *          the number to format
    * @return the formatted string
    * @exception IllegalArgumentException
-   *                    if bad argument
+   *              if bad argument
    */
   public String form(double x)
   {
@@ -579,7 +578,7 @@ public class Format
    * Formats a long integer into a string (like sprintf in C)
    * 
    * @param x
-   *                the number to format
+   *          the number to format
    * @return the formatted string
    */
   public String form(long x)
@@ -624,7 +623,7 @@ public class Format
    * Formats a character into a string (like sprintf in C)
    * 
    * @param x
-   *                the value to format
+   *          the value to format
    * @return the formatted string
    */
   public String form(char c)
@@ -643,7 +642,7 @@ public class Format
    * Formats a string into a larger string (like sprintf in C)
    * 
    * @param x
-   *                the value to format
+   *          the value to format
    * @return the formatted string
    */
   public String form(String s)
@@ -665,9 +664,9 @@ public class Format
    * DOCUMENT ME!
    * 
    * @param c
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * @param n
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * 
    * @return DOCUMENT ME!
    */
@@ -692,13 +691,13 @@ public class Format
    * DOCUMENT ME!
    * 
    * @param x
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * @param n
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * @param m
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * @param d
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * 
    * @return DOCUMENT ME!
    */
@@ -724,7 +723,7 @@ public class Format
    * DOCUMENT ME!
    * 
    * @param r
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * 
    * @return DOCUMENT ME!
    */
@@ -746,9 +745,9 @@ public class Format
    * DOCUMENT ME!
    * 
    * @param s
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * @param r
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * 
    * @return DOCUMENT ME!
    */
@@ -807,7 +806,7 @@ public class Format
    * DOCUMENT ME!
    * 
    * @param d
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * 
    * @return DOCUMENT ME!
    */
@@ -879,7 +878,7 @@ public class Format
    * DOCUMENT ME!
    * 
    * @param d
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * 
    * @return DOCUMENT ME!
    */