Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.codehaus.plexus.util.TypeFormat
public final class TypeFormat
extends java.lang.Object
CharSequence
into primitive types and to format primitive types into
StringBuffer
.
Methods from this utility class do not create temporary objects
and are typically faster than standard library methods (e.g parseDouble(CharSequence)
is up to 15x faster than Double.parseDouble
).
For class instances, formatting is typically performed using specialized
java.text.Format
(Locale
sensitive)
and/or using conventional methods (class sensitive). For example:public class Foo { public static Foo valueOf(CharSequence chars) {...} // Parses. public StringBuffer appendTo(StringBuffer sb) {...} // Formats. public String toString() { return appendTo(new StringBuffer()).toString(); } }This class is public domain (not copyrighted).
Field Summary | |
private static char[] |
|
private static double[] | |
private static double | |
private static float | |
private static int[] | |
private static String[] | |
private static double | |
private static long[] |
Constructor Summary | |
|
Method Summary | |
static StringBuffer |
|
static StringBuffer |
|
static StringBuffer |
|
private static StringBuffer |
|
static StringBuffer |
|
static StringBuffer |
|
static StringBuffer |
|
static StringBuffer |
|
static StringBuffer |
|
static StringBuffer |
|
static StringBuffer |
|
static StringBuffer |
|
static StringBuffer |
|
private static void |
|
private static void |
|
static int |
|
private static double |
|
static boolean |
|
static double |
|
static float |
|
static int |
|
static int |
|
static long |
|
static long |
|
static short |
|
static short |
|
private static final char[] DIGITS
Holds the characters used to represent numbers.
private static final double[] DOUBLE_POW_10
private static final double DOUBLE_RELATIVE_ERROR
private static final float FLOAT_RELATIVE_ERROR
private static final int[] INT_POW_10
private static String[] LEADING_ZEROS
private static final double LOG_10
private static final long[] LONG_POW_10
public static StringBuffer format(boolean b, StringBuffer sb)
Formats the specifiedboolean
and appends the resulting text to theStringBuffer
argument.
- Parameters:
b
- aboolean
.sb
- theStrinBuffer
to append.
- Returns:
- the specified
StringBuffer
object.
- See Also:
parseBoolean(CharSequence)
public static StringBuffer format(double d, StringBuffer sb)
Formats the specifieddouble
and appends the resulting text to theStringBuffer
argument. Note : This method is preferred toStringBuffer.append(double)
or evenString.valueOf(double)
as it does not create temporaryString
orFloatingDecimal
objects (several times faster, e.g. 15x faster forDouble.MAX_VALUE
).
- Parameters:
d
- thedouble
number.sb
- theStrinBuffer
to append.
- Returns:
format(d, 0.0, sb)
- See Also:
format(double,double,StringBuffer)
public static StringBuffer format(double d, double precision, StringBuffer sb)
Formats the specifieddouble
and appends the resulting text to theStringBuffer
argument; the number of significative digits is deduced from the specifed precision. All digits at least as significant as the specified precision are represented. For example:If the precision is
format(5.6, 0.01, sb)
appends"5.60"
format(5.6, 0.1, sb)
appends"5.6"
format(5.6, 1, sb)
appends"6"
0.0
, the precision is assumed to be the intrinsicdouble
precision (64 bits IEEE 754 format); no formatting is performed, all significant digits are displayed and trailing zeros are removed.
- Parameters:
d
- thedouble
number.precision
- the maximum weight of the last digit represented.sb
- theStrinBuffer
to append.
- Returns:
- the specified
StringBuffer
object.
private static StringBuffer format(double d, double precision, boolean precisionOnLastDigit, StringBuffer sb)
Formats the specifieddouble
and appends the resulting text to theStringBuffer
argument; the number of significative digits is deduced from the specifed precision.
- Parameters:
d
- thedouble
number.precision
- the maximum weight of the last digit represented.precisionOnLastDigit
- indicates if the number of digits is deduced from the specified precision.sb
- theStrinBuffer
to append.
- Returns:
- the specified
StringBuffer
object.
public static StringBuffer format(double d, int digits, StringBuffer sb)
Formats the specifieddouble
and appends the resulting text to theStringBuffer
argument; the number of significand digits is specified as integer argument.
- Parameters:
d
- thedouble
number.digits
- the number of significand digits (excludes exponent).sb
- theStrinBuffer
to append.
- Returns:
- the specified
StringBuffer
object.
public static StringBuffer format(float f, StringBuffer sb)
Formats the specifiedfloat
and appends the resulting text to theStringBuffer
argument.
- Parameters:
f
- thefloat
number.sb
- theStrinBuffer
to append.
- Returns:
format(f, 0.0f, sb)
- See Also:
format(float,float,StringBuffer)
public static StringBuffer format(float f, float precision, StringBuffer sb)
Formats the specifiedfloat
and appends the resulting text to theStringBuffer
argument; the number of significative digits is deduced from the specifed precision. All digits at least as significant as the specified precision are represented. For example:If the precision is
format(5.6f, 0.01f, sb)
appends"5.60"
format(5.6f, 0.1f, sb)
appends"5.6"
format(5.6f, 1f, sb)
appends"6"
0.0f
, the precision is assumed to be the intrinsicfloat
precision (64 bits IEEE 754 format); no formatting is performed, all significant digits are displayed and trailing zeros are removed.
- Parameters:
f
- thefloat
number.precision
- the maximum weight of the last digit represented.sb
- theStrinBuffer
to append.
- Returns:
- the specified
StringBuffer
object.
public static StringBuffer format(int i, StringBuffer sb)
Formats the specifiedint
and appends the resulting text (decimal representation) to theStringBuffer
argument. Note: This method is preferred toStringBuffer.append(int)
as it does not create temporaryString
objects (several times faster for small numbers).
- Parameters:
i
- theint
number.sb
- theStrinBuffer
to append.
- Returns:
- the specified
StringBuffer
object.
- See Also:
parseInt
public static StringBuffer format(int i, int radix, StringBuffer sb)
Formats the specifiedint
in the specified radix and appends the resulting text to theStringBuffer
argument.
- Parameters:
i
- theint
number.radix
- the radix.sb
- theStrinBuffer
to append.
- Returns:
- the specified
StringBuffer
object.
public static StringBuffer format(long l, StringBuffer sb)
Formats the specifiedlong
and appends the resulting text (decimal representation) to theStringBuffer
argument. Note: This method is preferred toStringBuffer.append(long)
as it does not create temporaryString
objects (several times faster for small numbers).
- Parameters:
l
- thelong
number.sb
- theStrinBuffer
to append.
- Returns:
- the specified
StringBuffer
object.
- See Also:
parseLong
public static StringBuffer format(long l, int radix, StringBuffer sb)
Formats the specifiedlong
in the specified radix and appends the resulting text to theStringBuffer
argument.
- Parameters:
l
- thelong
number.radix
- the radix.sb
- theStrinBuffer
to append.
- Returns:
- the specified
StringBuffer
object.
public static StringBuffer format(short s, StringBuffer sb)
Formats the specifiedshort
and appends the resulting text (decimal representation) to theStringBuffer
argument. Note: This method is preferred toStringBuffer.append(short)
as it does not create temporaryString
objects (several times faster for small numbers).
- Parameters:
s
- theshort
number.sb
- theStrinBuffer
to append.
- Returns:
- the specified
StringBuffer
object.
- See Also:
parseShort
public static StringBuffer format(short s, int radix, StringBuffer sb)
Formats the specifiedshort
in the specified radix and appends the resulting text to theStringBuffer
argument.
- Parameters:
s
- theshort
number.radix
- the radix.sb
- theStrinBuffer
to append.
- Returns:
- the specified
StringBuffer
object.
private static void format2(int i, int radix, StringBuffer sb)
private static void format2(long l, int radix, StringBuffer sb)
public static int indexOf(CharSequence pattern, CharSequence chars, int fromIndex)
Searches for a particular sequence within a character sequence (general purpose parsing function).
- Parameters:
pattern
- the character sequence to search for.chars
- the character sequence being searched.fromIndex
- the index inchars
to start the search from.
- Returns:
- the index in the range
[fromIndex, chars.length()-pattern.length()]
or-1
if the character sequence is not found.
private static final double multE(double value, int E)
Returns the product of the specified value with10
raised at the specified power exponent.
- Parameters:
value
- the value.E
- the exponent.
- Returns:
value * 10^E
public static boolean parseBoolean(CharSequence chars)
Parses the specifiedCharSequence
as aboolean
.
- Parameters:
chars
- the character sequence to parse.
- Returns:
- the corresponding
boolean
.
public static double parseDouble(CharSequence chars) throws NumberFormatException
Parses thisCharSequence
as adouble
.
- Parameters:
chars
- the character sequence to parse.
- Returns:
- the double number represented by this character sequence.
public static float parseFloat(CharSequence chars)
Parses thisCharSequence
as afloat
.
- Parameters:
chars
- the character sequence to parse.
- Returns:
- the float number represented by the specified character sequence.
public static int parseInt(CharSequence chars)
Parses the specifiedCharSequence
as a signed decimalint
.
- Parameters:
chars
- the character sequence to parse.
- Returns:
parseInt(chars, 10)
- See Also:
parseInt(CharSequence,int)
public static int parseInt(CharSequence chars, int radix)
Parses the specifiedCharSequence
as a signedint
in the specified radix. The characters in the string must all be digits of the specified radix, except the first character which may be a plus sign'+'
or a minus sign'-'
.
- Parameters:
chars
- the character sequence to parse.radix
- the radix to be used while parsing.
- Returns:
- the corresponding
int
.
public static long parseLong(CharSequence chars)
Parses the specifiedCharSequence
as a signed decimallong
.
- Parameters:
chars
- the character sequence to parse.
- Returns:
parseLong(chars, 10)
- See Also:
parseLong(CharSequence,int)
public static long parseLong(CharSequence chars, int radix)
Parses the specifiedCharSequence
as a signedlong
in the specified radix. The characters in the string must all be digits of the specified radix, except the first character which may be a plus sign'+'
or a minus sign'-'
.
- Parameters:
chars
- the character sequence to parse.radix
- the radix to be used while parsing.
- Returns:
- the corresponding
long
.
public static short parseShort(CharSequence chars)
Parses the specifiedCharSequence
as a signed decimalshort
.
- Parameters:
chars
- the character sequence to parse.
- Returns:
parseShort(chars, 10)
- See Also:
parseShort(CharSequence,int)
public static short parseShort(CharSequence chars, int radix)
Parses the specifiedCharSequence
as a signedshort
in the specified radix. The characters in the string must all be digits of the specified radix, except the first character which may be a plus sign'+'
or a minus sign'-'
.
- Parameters:
chars
- the character sequence to parse.radix
- the radix to be used while parsing.
- Returns:
- the corresponding
short
.