X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Fjalview%2Futil%2FFormat.java;h=d14e4ad992f4c51e50c6b1fc24c440293cdfc11b;hb=3ed5c0f91614bb7a3620ec3a968a54bafdbd74ad;hp=46abdb95ab2648f0aa75da6aa1a8fea1d94ff6ea;hpb=506d60f0e188723ddc91c26824b41ac7034df3fe;p=jalview.git
diff --git a/src/jalview/util/Format.java b/src/jalview/util/Format.java
index 46abdb9..d14e4ad 100755
--- a/src/jalview/util/Format.java
+++ b/src/jalview/util/Format.java
@@ -1,20 +1,22 @@
/*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
- * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
*
- * 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.
+ *
+ * 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 this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ * along with Jalview. If not, see .
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
*/
/**
* A class for formatting numbers that follows printf conventions.
@@ -52,14 +54,17 @@ public class Format
private char fmt; // one of cdeEfgGiosxXos
+ private final String formatString;
+
/**
* Creates a new Format object.
*
* @param s
- * DOCUMENT ME!
+ * DOCUMENT ME!
*/
public Format(String s)
{
+ formatString = s;
width = 0;
precision = -1;
pre = "";
@@ -212,60 +217,57 @@ public class 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
- *
- * - a % (required)
- *
- a modifier (optional)
- *
- * - +
- *
- forces display of + for positive numbers
- *
- 0
- *
- show leading zeroes
- *
- -
- *
- align left in the field
- *
- space
- *
- prepend a space in front of positive numbers
- *
- #
- *
- use "alternate" format. Add 0 or 0x for octal or
- * hexadecimal numbers. Don't suppress trailing zeroes in
- * general floating point format.
- *
- * - an integer denoting field width (optional)
- *
- a period followed by an integer denoting precision
- * (optional)
- *
- a format descriptor (required)
- *
- * - f
- *
- floating point number in fixed format
- *
- e, E
- *
- 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.
- *
- g, G
- *
- 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.
- *
- d, i
- *
- integer in decimal
- *
- x
- *
- integer in hexadecimal
- *
- o
- *
- integer in octal
- *
- s
- *
- string
- *
- c
- *
- character
- *
- *
+ * 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
+ *
+ * - a % (required)
+ *
- a modifier (optional)
+ *
+ * - +
+ *
- forces display of + for positive numbers
+ *
- 0
+ *
- show leading zeroes
+ *
- -
+ *
- align left in the field
+ *
- space
+ *
- prepend a space in front of positive numbers
+ *
- #
+ *
- use "alternate" format. Add 0 or 0x for octal or hexadecimal
+ * numbers. Don't suppress trailing zeroes in general floating point
+ * format.
+ *
+ * - an integer denoting field width (optional)
+ *
- a period followed by an integer denoting precision (optional)
+ *
- a format descriptor (required)
+ *
+ * - f
+ *
- floating point number in fixed format
+ *
- e, E
+ *
- 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.
+ *
- g, G
+ *
- 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.
+ *
- d, i
+ *
- integer in decimal
+ *
- x
+ *
- integer in hexadecimal
+ *
- o
+ *
- integer in octal
+ *
- s
+ *
- string
+ *
- c
+ *
- character
+ *
+ *
* @exception IllegalArgumentException
- * if bad format
+ * if bad format
*
*/
public static String getHexString(java.awt.Color color)
@@ -301,11 +303,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 +318,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 +333,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 +348,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 +361,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 +373,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 +407,9 @@ public class Format
* DOCUMENT ME!
*
* @param s
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param base
- * DOCUMENT ME!
+ * DOCUMENT ME!
*
* @return DOCUMENT ME!
*/
@@ -463,7 +465,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 +539,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 +581,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)
@@ -623,8 +625,8 @@ public class Format
/**
* Formats a character into a string (like sprintf in C)
*
- * @param x
- * the value to format
+ * @param debounceTrap
+ * the value to format
* @return the formatted string
*/
public String form(char c)
@@ -642,8 +644,8 @@ public class Format
/**
* Formats a string into a larger string (like sprintf in C)
*
- * @param x
- * the value to format
+ * @param debounceTrap
+ * the value to format
* @return the formatted string
*/
public String form(String s)
@@ -665,9 +667,9 @@ public class Format
* DOCUMENT ME!
*
* @param c
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param n
- * DOCUMENT ME!
+ * DOCUMENT ME!
*
* @return DOCUMENT ME!
*/
@@ -692,13 +694,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 +726,7 @@ public class Format
* DOCUMENT ME!
*
* @param r
- * DOCUMENT ME!
+ * DOCUMENT ME!
*
* @return DOCUMENT ME!
*/
@@ -746,9 +748,9 @@ public class Format
* DOCUMENT ME!
*
* @param s
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param r
- * DOCUMENT ME!
+ * DOCUMENT ME!
*
* @return DOCUMENT ME!
*/
@@ -807,7 +809,7 @@ public class Format
* DOCUMENT ME!
*
* @param d
- * DOCUMENT ME!
+ * DOCUMENT ME!
*
* @return DOCUMENT ME!
*/
@@ -879,7 +881,7 @@ public class Format
* DOCUMENT ME!
*
* @param d
- * DOCUMENT ME!
+ * DOCUMENT ME!
*
* @return DOCUMENT ME!
*/
@@ -939,4 +941,10 @@ public class Format
return f + p.substring(p.length() - 3, p.length());
}
+
+ @Override
+ public String toString()
+ {
+ return formatString;
+ }
}