JAL-1503 update version in GPL header
[jalview.git] / src / jalview / util / Format.java
index c6348b2..5bab738 100755 (executable)
@@ -1,19 +1,20 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
+ * Copyright (C) 2014 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.
- * 
+ *  
  * 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/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 /**
  * A class for formatting numbers that follows printf conventions.
@@ -205,66 +206,63 @@ 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
    * 
    * @param s
-   *                the format string following printf conventions The string
-   *                has a prefix, a format code and a suffix. The prefix and
-   *                suffix become part of the formatted output. The format code
-   *                directs the formatting of the (single) parameter to be
-   *                formatted. The code has the following structure
-   *                <ul>
-   *                <li> a % (required)
-   *                <li> a modifier (optional)
-   *                <dl>
-   *                <dt> +
-   *                <dd> forces display of + for positive numbers
-   *                <dt> 0
-   *                <dd> show leading zeroes
-   *                <dt> -
-   *                <dd> align left in the field
-   *                <dt> space
-   *                <dd> prepend a space in front of positive numbers
-   *                <dt> #
-   *                <dd> use "alternate" format. Add 0 or 0x for octal or
-   *                hexadecimal numbers. Don't suppress trailing zeroes in
-   *                general floating point format.
-   *                </dl>
-   *                <li> an integer denoting field width (optional)
-   *                <li> a period followed by an integer denoting precision
-   *                (optional)
-   *                <li> a format descriptor (required)
-   *                <dl>
-   *                <dt>f
-   *                <dd> floating point number in fixed format
-   *                <dt>e, E
-   *                <dd> floating point number in exponential notation
-   *                (scientific format). The E format results in an uppercase E
-   *                for the exponent (1.14130E+003), the e format in a lowercase
-   *                e.
-   *                <dt>g, G
-   *                <dd> floating point number in general format (fixed format
-   *                for small numbers, exponential format for large numbers).
-   *                Trailing zeroes are suppressed. The G format results in an
-   *                uppercase E for the exponent (if any), the g format in a
-   *                lowercase e.
-   *                <dt>d, i
-   *                <dd> integer in decimal
-   *                <dt>x
-   *                <dd> integer in hexadecimal
-   *                <dt>o
-   *                <dd> integer in octal
-   *                <dt>s
-   *                <dd> string
-   *                <dt>c
-   *                <dd> character
-   *                </dl>
-   *                </ul>
+   *          the format string following printf conventions The string has a
+   *          prefix, a format code and a suffix. The prefix and suffix become
+   *          part of the formatted output. The format code directs the
+   *          formatting of the (single) parameter to be formatted. The code has
+   *          the following structure
+   *          <ul>
+   *          <li>a % (required)
+   *          <li>a modifier (optional)
+   *          <dl>
+   *          <dt>+
+   *          <dd>forces display of + for positive numbers
+   *          <dt>0
+   *          <dd>show leading zeroes
+   *          <dt>-
+   *          <dd>align left in the field
+   *          <dt>space
+   *          <dd>prepend a space in front of positive numbers
+   *          <dt>#
+   *          <dd>use "alternate" format. Add 0 or 0x for octal or hexadecimal
+   *          numbers. Don't suppress trailing zeroes in general floating point
+   *          format.
+   *          </dl>
+   *          <li>an integer denoting field width (optional)
+   *          <li>a period followed by an integer denoting precision (optional)
+   *          <li>a format descriptor (required)
+   *          <dl>
+   *          <dt>f
+   *          <dd>floating point number in fixed format
+   *          <dt>e, E
+   *          <dd>floating point number in exponential notation (scientific
+   *          format). The E format results in an uppercase E for the exponent
+   *          (1.14130E+003), the e format in a lowercase e.
+   *          <dt>g, G
+   *          <dd>floating point number in general format (fixed format for
+   *          small numbers, exponential format for large numbers). Trailing
+   *          zeroes are suppressed. The G format results in an uppercase E for
+   *          the exponent (if any), the g format in a lowercase e.
+   *          <dt>d, i
+   *          <dd>integer in decimal
+   *          <dt>x
+   *          <dd>integer in hexadecimal
+   *          <dt>o
+   *          <dd>integer in octal
+   *          <dt>s
+   *          <dd>string
+   *          <dt>c
+   *          <dd>character
+   *          </dl>
+   *          </ul>
    * @exception IllegalArgumentException
-   *                    if bad format
+   *              if bad format
    * 
    */
   public static String getHexString(java.awt.Color color)