Class TypeFormat
This class provides utility methods to parse 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(java.lang.CharSequence)
is up to 15x faster than Double.parseDouble
).
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).
- Version:
- 4.6, June 22, 2003
- Author:
- Jean-Marie Dautelle
-
Method Summary
Modifier and TypeMethodDescriptionstatic StringBuffer
format
(boolean b, StringBuffer sb) Formats the specifiedboolean
and appends the resulting text to theStringBuffer
argument.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 specified precision.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.static StringBuffer
format
(double d, StringBuffer sb) Formats the specifieddouble
and appends the resulting text to theStringBuffer
argument.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 specified precision.static StringBuffer
format
(float f, StringBuffer sb) Formats the specifiedfloat
and appends the resulting text to theStringBuffer
argument.static StringBuffer
format
(int i, int radix, StringBuffer sb) Formats the specifiedint
in the specified radix and appends the resulting text to theStringBuffer
argument.static StringBuffer
format
(int i, StringBuffer sb) Formats the specifiedint
and appends the resulting text (decimal representation) to theStringBuffer
argument.static StringBuffer
format
(long l, int radix, StringBuffer sb) Formats the specifiedlong
in the specified radix and appends the resulting text to theStringBuffer
argument.static StringBuffer
format
(long l, StringBuffer sb) Formats the specifiedlong
and appends the resulting text (decimal representation) to theStringBuffer
argument.static StringBuffer
format
(short s, int radix, StringBuffer sb) Formats the specifiedshort
in the specified radix and appends the resulting text to theStringBuffer
argument.static StringBuffer
format
(short s, StringBuffer sb) Formats the specifiedshort
and appends the resulting text (decimal representation) to theStringBuffer
argument.static int
indexOf
(CharSequence pattern, CharSequence chars, int fromIndex) Searches for a particular sequence within a character sequence (general purpose parsing function).static boolean
parseBoolean
(CharSequence chars) Parses the specifiedCharSequence
as aboolean
.static double
parseDouble
(CharSequence chars) Parses thisCharSequence
as adouble
.static float
parseFloat
(CharSequence chars) Parses thisCharSequence
as afloat
.static int
parseInt
(CharSequence chars) Parses the specifiedCharSequence
as a signed decimalint
.static int
parseInt
(CharSequence chars, int radix) Parses the specifiedCharSequence
as a signedint
in the specified radix.static long
parseLong
(CharSequence chars) Parses the specifiedCharSequence
as a signed decimallong
.static long
parseLong
(CharSequence chars, int radix) Parses the specifiedCharSequence
as a signedlong
in the specified radix.static short
parseShort
(CharSequence chars) Parses the specifiedCharSequence
as a signed decimalshort
.static short
parseShort
(CharSequence chars, int radix) Parses the specifiedCharSequence
as a signedshort
in the specified radix.
-
Method Details
-
indexOf
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.
-
parseBoolean
Parses the specifiedCharSequence
as aboolean
.- Parameters:
chars
- the character sequence to parse.- Returns:
- the corresponding
boolean
.
-
parseShort
Parses the specifiedCharSequence
as a signed decimalshort
.- Parameters:
chars
- the character sequence to parse.- Returns:
parseShort(chars, 10)
- Throws:
NumberFormatException
- if the specified character sequence does not contain a parsableshort
.- See Also:
-
parseShort
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
. - Throws:
NumberFormatException
- if the specified character sequence does not contain a parsableshort
.
-
parseInt
Parses the specifiedCharSequence
as a signed decimalint
.- Parameters:
chars
- the character sequence to parse.- Returns:
parseInt(chars, 10)
- Throws:
NumberFormatException
- if the specified character sequence does not contain a parsableint
.- See Also:
-
parseInt
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
. - Throws:
NumberFormatException
- if the specified character sequence does not contain a parsableint
.
-
parseLong
Parses the specifiedCharSequence
as a signed decimallong
.- Parameters:
chars
- the character sequence to parse.- Returns:
parseLong(chars, 10)
- Throws:
NumberFormatException
- if the specified character sequence does not contain a parsablelong
.- See Also:
-
parseLong
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
. - Throws:
NumberFormatException
- if the specified character sequence does not contain a parsablelong
.
-
parseFloat
Parses thisCharSequence
as afloat
.- Parameters:
chars
- the character sequence to parse.- Returns:
- the float number represented by the specified character sequence.
- Throws:
NumberFormatException
- if the character sequence does not contain a parsablefloat
.
-
parseDouble
Parses thisCharSequence
as adouble
.- Parameters:
chars
- the character sequence to parse.- Returns:
- the double number represented by this character sequence.
- Throws:
NumberFormatException
- if the character sequence does not contain a parsabledouble
.
-
format
Formats the specifiedboolean
and appends the resulting text to theStringBuffer
argument.- Parameters:
b
- aboolean
.sb
- theStringBuffer
to append.- Returns:
- the specified
StringBuffer
object. - See Also:
-
format
Formats the specifiedshort
and appends the resulting text (decimal representation) to theStringBuffer
argument.Note: This method is preferred to
StringBuffer.append(short)
as it does not create temporaryString
objects (several times faster for small numbers).- Parameters:
s
- theshort
number.sb
- theStringBuffer
to append.- Returns:
- the specified
StringBuffer
object. - See Also:
-
format
Formats the specifiedshort
in the specified radix and appends the resulting text to theStringBuffer
argument.- Parameters:
s
- theshort
number.radix
- the radix.sb
- theStringBuffer
to append.- Returns:
- the specified
StringBuffer
object. - See Also:
-
format
Formats the specifiedint
and appends the resulting text (decimal representation) to theStringBuffer
argument.Note: This method is preferred to
StringBuffer.append(int)
as it does not create temporaryString
objects (several times faster for small numbers).- Parameters:
i
- theint
number.sb
- theStringBuffer
to append.- Returns:
- the specified
StringBuffer
object. - See Also:
-
format
Formats the specifiedint
in the specified radix and appends the resulting text to theStringBuffer
argument.- Parameters:
i
- theint
number.radix
- the radix.sb
- theStringBuffer
to append.- Returns:
- the specified
StringBuffer
object. - See Also:
-
format
Formats the specifiedlong
and appends the resulting text (decimal representation) to theStringBuffer
argument.Note: This method is preferred to
StringBuffer.append(long)
as it does not create temporaryString
objects (several times faster for small numbers).- Parameters:
l
- thelong
number.sb
- theStringBuffer
to append.- Returns:
- the specified
StringBuffer
object. - See Also:
-
format
Formats the specifiedlong
in the specified radix and appends the resulting text to theStringBuffer
argument.- Parameters:
l
- thelong
number.radix
- the radix.sb
- theStringBuffer
to append.- Returns:
- the specified
StringBuffer
object. - See Also:
-
format
Formats the specifiedfloat
and appends the resulting text to theStringBuffer
argument.- Parameters:
f
- thefloat
number.sb
- theStringBuffer
to append.- Returns:
format(f, 0.0f, sb)
- See Also:
-
format
Formats the specifiedfloat
and appends the resulting text to theStringBuffer
argument; the number of significative digits is deduced from the specified precision. All digits at least as significant as the specified precision are represented. For example: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
- theStringBuffer
to append.- Returns:
- the specified
StringBuffer
object. - Throws:
IllegalArgumentException
- if the specified precision is negative or would result in too many digits (19+).
-
format
Formats the specifieddouble
and appends the resulting text to theStringBuffer
argument.Note : This method is preferred to
StringBuffer.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
- theStringBuffer
to append.- Returns:
format(d, 0.0, sb)
- See Also:
-
format
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
- theStringBuffer
to append.- Returns:
- the specified
StringBuffer
object. - Throws:
IllegalArgumentException
- if the number of digits is not in range[1..19]
.
-
format
Formats the specifieddouble
and appends the resulting text to theStringBuffer
argument; the number of significative digits is deduced from the specified precision. All digits at least as significant as the specified precision are represented. For example: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
- theStringBuffer
to append.- Returns:
- the specified
StringBuffer
object. - Throws:
IllegalArgumentException
- if the specified precision is negative or would result in too many digits (19+).
-