Class NumberFormat
- All Implemented Interfaces:
-
Serializable,Cloneable
- Direct Known Subclasses:
-
ChoiceFormat,CompactNumberFormat,DecimalFormat
public abstract class NumberFormat extends Format
NumberFormat is the abstract base class for all number formats. This class provides the interface for formatting and parsing numbers. NumberFormat also provides methods for determining which locales have number formats, and what their names are. NumberFormat helps you to format and parse numbers for any locale. Your code can be completely independent of the locale conventions for decimal points, thousands-separators, or even the particular decimal digits used, or whether the number format is even decimal.
To format a number for the current Locale, use one of the factory class methods:
If you are formatting multiple numbers, it is more efficient to get the format and use it multiple times so that the system doesn't have to fetch the information about the local language and country conventions multiple times.myString = NumberFormat.getInstance().format(myNumber);
To format a number for a different Locale, specify it in the call toNumberFormat nf = NumberFormat.getInstance(); for (int i = 0; i < myNumber.length; ++i) { output.println(nf.format(myNumber[i]) + "; "); }
getInstance. NumberFormat nf = NumberFormat.getInstance(Locale.FRENCH);
If the locale contains "nu" (numbers) and/or "rg" (region override) Unicode extensions, the decimal digits, and/or the country used for formatting are overridden. If both "nu" and "rg" are specified, the decimal digits from the "nu" extension supersedes the implicit one from the "rg" extension.
You can also use a NumberFormat to parse numbers:
UsemyNumber = nf.parse(myString);
getInstance or getNumberInstance to get the normal number format. Use getIntegerInstance to get an integer number format. Use getCurrencyInstance to get the currency number format. Use getCompactNumberInstance to get the compact number format to format a number in shorter form. For example, 2000 can be formatted as "2K" in US locale. Use getPercentInstance to get a format for displaying percentages. With this format, a fraction like 0.53 is displayed as 53%. You can also control the display of numbers with such methods as setMinimumFractionDigits. If you want even more control over the format or parsing, or want to give your users more control, you can try casting the NumberFormat you get from the factory methods to a DecimalFormat or CompactNumberFormat depending on the factory method used. This will work for the vast majority of locales; just remember to put it in a try block in case you encounter an unusual one.
NumberFormat and DecimalFormat are designed such that some controls work for formatting and others work for parsing. The following is the detailed description for each these control methods,
setParseIntegerOnly : only affects parsing, e.g. if true, "3456.78" → 3456 (and leaves the parse position just after index 6) if false, "3456.78" → 3456.78 (and leaves the parse position just after index 8) This is independent of formatting. If you want to not show a decimal point where there might be no digits after the decimal point, use setDecimalSeparatorAlwaysShown.
setDecimalSeparatorAlwaysShown : only affects formatting, and only where there might be no digits after the decimal point, such as with a pattern like "#,##0.##", e.g., if true, 3456.00 → "3,456." if false, 3456.00 → "3456" This is independent of parsing. If you want parsing to stop at the decimal point, use setParseIntegerOnly.
You can also use forms of the parse and format methods with ParsePosition and FieldPosition to allow you to:
- progressively parse through pieces of a string
- align the decimal point and other areas
- If you are using a monospaced font with spacing for alignment, you can pass the
FieldPositionin your format call, withfield=INTEGER_FIELD. On output,getEndIndexwill be set to the offset between the last character of the integer and the decimal. Add (desiredSpaceCount - getEndIndex) spaces at the front of the string. - If you are using proportional fonts, instead of padding with spaces, measure the width of the string in pixels from the start to
getEndIndex. Then move the pen by (desiredPixelWidth - widthToAlignmentPoint) before drawing the text. It also works where there is no decimal, but possibly additional characters at the end, e.g., with parentheses in negative numbers: "(12)" for -12.
Synchronization
Number formats are generally not synchronized. It is recommended to create separate format instances for each thread. If multiple threads access a format concurrently, it must be synchronized externally.
- Implementation Requirements:
- The
format(double, StringBuffer, FieldPosition),format(long, StringBuffer, FieldPosition)andparse(String, ParsePosition)methods may throwNullPointerException, if any of their parameter isnull. The subclass may provide its own implementation and specification aboutNullPointerException.The default implementation provides rounding modes defined in
RoundingModefor formatting numbers. It uses the round half-even algorithm. To change the rounding mode usesetRoundingMode. TheNumberFormatreturned by the static factory methods is configured to round floating point numbers using half-even rounding (seeRoundingMode.HALF_EVEN) for formatting. - Since:
- 1.1
- See Also:
Nested Class Summary
| Modifier and Type | Class | Description |
|---|---|---|
static class |
NumberFormat.Field |
Defines constants that are used as attribute keys in the AttributedCharacterIterator returned from NumberFormat.formatToCharacterIterator and as field identifiers in FieldPosition. |
static enum |
NumberFormat.Style |
A number format style. |
Field Summary
| Modifier and Type | Field | Description |
|---|---|---|
static final int |
FRACTION_FIELD |
Field constant used to construct a FieldPosition object. |
static final int |
INTEGER_FIELD |
Field constant used to construct a FieldPosition object. |
Constructor Summary
| Modifier | Constructor | Description |
|---|---|---|
protected |
Sole constructor. |
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
Object |
clone() |
Overrides Cloneable. |
boolean |
equals |
Overrides equals. |
final String |
format |
Specialization of format. |
abstract StringBuffer |
format |
Specialization of format. |
final String |
format |
Specialization of format. |
abstract StringBuffer |
format |
Specialization of format. |
StringBuffer |
format |
Formats a number and appends the resulting text to the given string buffer. |
static Locale[] |
getAvailableLocales() |
Returns an array of all locales for which the get*Instance methods of this class can return localized instances. |
static NumberFormat |
getCompactNumberInstance() |
|
static NumberFormat |
getCompactNumberInstance |
Returns a compact number format for the specified locale and formatStyle. |
Currency |
getCurrency() |
Gets the currency used by this number format when formatting currency values. |
static final NumberFormat |
getCurrencyInstance() |
Returns a currency format for the current default FORMAT locale. |
static NumberFormat |
getCurrencyInstance |
Returns a currency format for the specified locale. |
static final NumberFormat |
getInstance() |
Returns a general-purpose number format for the current default FORMAT locale. |
static NumberFormat |
getInstance |
Returns a general-purpose number format for the specified locale. |
static final NumberFormat |
getIntegerInstance() |
Returns an integer number format for the current default FORMAT locale. |
static NumberFormat |
getIntegerInstance |
Returns an integer number format for the specified locale. |
int |
getMaximumFractionDigits() |
Returns the maximum number of digits allowed in the fraction portion of a number. |
int |
getMaximumIntegerDigits() |
Returns the maximum number of digits allowed in the integer portion of a number. |
int |
getMinimumFractionDigits() |
Returns the minimum number of digits allowed in the fraction portion of a number. |
int |
getMinimumIntegerDigits() |
Returns the minimum number of digits allowed in the integer portion of a number. |
static final NumberFormat |
getNumberInstance() |
Returns a general-purpose number format for the current default FORMAT locale. |
static NumberFormat |
getNumberInstance |
Returns a general-purpose number format for the specified locale. |
static final NumberFormat |
getPercentInstance() |
Returns a percentage format for the current default FORMAT locale. |
static NumberFormat |
getPercentInstance |
Returns a percentage format for the specified locale. |
RoundingMode |
getRoundingMode() |
Gets the RoundingMode used in this NumberFormat. |
int |
hashCode() |
Overrides hashCode. |
boolean |
isGroupingUsed() |
Returns true if grouping is used in this format. |
boolean |
isParseIntegerOnly() |
Returns true if this format will parse numbers as integers only. |
Number |
parse |
Parses text from the beginning of the given string to produce a number. |
abstract Number |
parse |
Returns a Long if possible (e.g., within the range [Long.MIN_VALUE, Long.MAX_VALUE] and with no decimals), otherwise a Double. |
final Object |
parseObject |
Parses text from a string to produce a Number. |
void |
setCurrency |
Sets the currency used by this number format when formatting currency values. |
void |
setGroupingUsed |
Set whether or not grouping will be used in this format. |
void |
setMaximumFractionDigits |
Sets the maximum number of digits allowed in the fraction portion of a number. maximumFractionDigits must be ≥ minimumFractionDigits. |
void |
setMaximumIntegerDigits |
Sets the maximum number of digits allowed in the integer portion of a number. maximumIntegerDigits must be ≥ minimumIntegerDigits. |
void |
setMinimumFractionDigits |
Sets the minimum number of digits allowed in the fraction portion of a number. minimumFractionDigits must be ≤ maximumFractionDigits. |
void |
setMinimumIntegerDigits |
Sets the minimum number of digits allowed in the integer portion of a number. minimumIntegerDigits must be ≤ maximumIntegerDigits. |
void |
setParseIntegerOnly |
Sets whether or not numbers should be parsed as integers only. |
void |
setRoundingMode |
Sets the RoundingMode used in this NumberFormat. |
Methods declared in class java.text.Format
format, formatToCharacterIterator, parseObject
Field Details
INTEGER_FIELD
public static final int INTEGER_FIELD
- See Also:
FRACTION_FIELD
public static final int FRACTION_FIELD
- See Also:
Constructor Details
NumberFormat
protected NumberFormat()
Method Details
format
public StringBuffer format(Object number, StringBuffer toAppendTo, FieldPosition pos)
Number. This implementation extracts the number's value using Number.longValue() for all integral type values that can be converted to long without loss of information, including BigInteger values with a bit length of less than 64, and Number.doubleValue() for all other types. It then calls format(long,java.lang.StringBuffer,java.text.FieldPosition) or format(double,java.lang.StringBuffer,java.text.FieldPosition). This may result in loss of magnitude information and precision for BigInteger and BigDecimal values.
- Specified by:
-
formatin classFormat - Parameters:
-
number- the number to format -
toAppendTo- theStringBufferto which the formatted text is to be appended -
pos- keeps track on the position of the field within the returned string. For example, for formatting a number1234567.89inLocale.USlocale, if the givenfieldPositionisINTEGER_FIELD, the begin index and end index offieldPositionwill be set to 0 and 9, respectively for the output string1,234,567.89. - Returns:
- the value passed in as
toAppendTo - Throws:
-
IllegalArgumentException- ifnumberis null or not an instance ofNumber. -
NullPointerException- iftoAppendToorposis null -
ArithmeticException- if rounding is needed with rounding mode being set to RoundingMode.UNNECESSARY - See Also:
parseObject
public final Object parseObject(String source, ParsePosition pos)
Number. The method attempts to parse text starting at the index given by pos. If parsing succeeds, then the index of pos is updated to the index after the last character used (parsing does not necessarily use all characters up to the end of the string), and the parsed number is returned. The updated pos can be used to indicate the starting point for the next call to this method. If an error occurs, then the index of pos is not changed, the error index of pos is set to the index of the character where the error occurred, and null is returned.
See the parse(String, ParsePosition) method for more information on number parsing.
- Specified by:
-
parseObjectin classFormat - Parameters:
-
source- AString, part of which should be parsed. -
pos- AParsePositionobject with index and error index information as described above. - Returns:
- A
Numberparsed from the string. In case of error, returns null. - Throws:
-
NullPointerException- ifsourceorposis null.
format
public final String format(double number)
- Parameters:
-
number- the double number to format - Returns:
- the formatted String
- Throws:
-
ArithmeticException- if rounding is needed with rounding mode being set to RoundingMode.UNNECESSARY - See Also:
format
public final String format(long number)
- Parameters:
-
number- the long number to format - Returns:
- the formatted String
- Throws:
-
ArithmeticException- if rounding is needed with rounding mode being set to RoundingMode.UNNECESSARY - See Also:
format
public abstract StringBuffer format(double number, StringBuffer toAppendTo, FieldPosition pos)
- Parameters:
-
number- the double number to format -
toAppendTo- the StringBuffer to which the formatted text is to be appended -
pos- keeps track on the position of the field within the returned string. For example, for formatting a number1234567.89inLocale.USlocale, if the givenfieldPositionisINTEGER_FIELD, the begin index and end index offieldPositionwill be set to 0 and 9, respectively for the output string1,234,567.89. - Returns:
- the formatted StringBuffer
- Throws:
-
ArithmeticException- if rounding is needed with rounding mode being set to RoundingMode.UNNECESSARY - See Also:
format
public abstract StringBuffer format(long number, StringBuffer toAppendTo, FieldPosition pos)
- Parameters:
-
number- the long number to format -
toAppendTo- the StringBuffer to which the formatted text is to be appended -
pos- keeps track on the position of the field within the returned string. For example, for formatting a number123456789inLocale.USlocale, if the givenfieldPositionisINTEGER_FIELD, the begin index and end index offieldPositionwill be set to 0 and 11, respectively for the output string123,456,789. - Returns:
- the formatted StringBuffer
- Throws:
-
ArithmeticException- if rounding is needed with rounding mode being set to RoundingMode.UNNECESSARY - See Also:
parse
public abstract Number parse(String source, ParsePosition parsePosition)
- Parameters:
-
source- the String to parse -
parsePosition- the parse position - Returns:
- the parsed value
- See Also:
parse
public Number parse(String source) throws ParseException
See the parse(String, ParsePosition) method for more information on number parsing.
- Parameters:
-
source- AStringwhose beginning should be parsed. - Returns:
- A
Numberparsed from the string. - Throws:
-
ParseException- if the beginning of the specified string cannot be parsed.
isParseIntegerOnly
public boolean isParseIntegerOnly()
- Returns:
-
trueif numbers should be parsed as integers only;falseotherwise
setParseIntegerOnly
public void setParseIntegerOnly(boolean value)
- Parameters:
-
value-trueif numbers should be parsed as integers only;falseotherwise - See Also:
getInstance
public static final NumberFormat getInstance()
FORMAT locale. This is the same as calling getNumberInstance().- Returns:
- the
NumberFormatinstance for general-purpose number formatting
getInstance
public static NumberFormat getInstance(Locale inLocale)
getNumberInstance(inLocale).- Parameters:
-
inLocale- the desired locale - Returns:
- the
NumberFormatinstance for general-purpose number formatting
getNumberInstance
public static final NumberFormat getNumberInstance()
FORMAT locale. This is equivalent to calling getNumberInstance(Locale.getDefault(Locale.Category.FORMAT)).
- Returns:
- the
NumberFormatinstance for general-purpose number formatting - See Also:
getNumberInstance
public static NumberFormat getNumberInstance(Locale inLocale)
- Parameters:
-
inLocale- the desired locale - Returns:
- the
NumberFormatinstance for general-purpose number formatting
getIntegerInstance
public static final NumberFormat getIntegerInstance()
FORMAT locale. The returned number format is configured to round floating point numbers to the nearest integer using half-even rounding (see RoundingMode.HALF_EVEN) for formatting, and to parse only the integer part of an input string (see isParseIntegerOnly). This is equivalent to calling getIntegerInstance(Locale.getDefault(Locale.Category.FORMAT)).
- Returns:
- a number format for integer values
- Since:
- 1.4
- See Also:
getIntegerInstance
public static NumberFormat getIntegerInstance(Locale inLocale)
RoundingMode.HALF_EVEN) for formatting, and to parse only the integer part of an input string (see isParseIntegerOnly).- Parameters:
-
inLocale- the desired locale - Returns:
- a number format for integer values
- Since:
- 1.4
- See Also:
getCurrencyInstance
public static final NumberFormat getCurrencyInstance()
FORMAT locale. This is equivalent to calling getCurrencyInstance(Locale.getDefault(Locale.Category.FORMAT)).
- Returns:
- the
NumberFormatinstance for currency formatting - See Also:
getCurrencyInstance
public static NumberFormat getCurrencyInstance(Locale inLocale)
If the specified locale contains the "cf" ( currency format style) Unicode extension, the returned currency format uses the style if it is available. Otherwise, the style uses the default "standard" currency format. For example, if the style designates "account", negative currency amounts use a pair of parentheses in some locales.
- Parameters:
-
inLocale- the desired locale - Returns:
- the
NumberFormatinstance for currency formatting
getPercentInstance
public static final NumberFormat getPercentInstance()
FORMAT locale. This is equivalent to calling getPercentInstance(Locale.getDefault(Locale.Category.FORMAT)).
- Returns:
- the
NumberFormatinstance for percentage formatting - See Also:
getPercentInstance
public static NumberFormat getPercentInstance(Locale inLocale)
- Parameters:
-
inLocale- the desired locale - Returns:
- the
NumberFormatinstance for percentage formatting
getCompactNumberInstance
public static NumberFormat getCompactNumberInstance()
- Returns:
- A
NumberFormatinstance for compact number formatting - Since:
- 12
- See Also:
getCompactNumberInstance
public static NumberFormat getCompactNumberInstance(Locale locale, NumberFormat.Style formatStyle)
locale and formatStyle.- Parameters:
-
locale- the desired locale -
formatStyle- the style for formatting a number - Returns:
- A
NumberFormatinstance for compact number formatting - Throws:
-
NullPointerException- iflocaleorformatStyleisnull - Since:
- 12
- See Also:
getAvailableLocales
public static Locale[] getAvailableLocales()
get*Instance methods of this class can return localized instances. The returned array represents the union of locales supported by the Java runtime and by installed NumberFormatProvider implementations. It must contain at least a Locale instance equal to Locale.US.- Returns:
- An array of locales for which localized
NumberFormatinstances are available.
hashCode
public int hashCode()
equals
public boolean equals(Object obj)
clone
public Object clone()
isGroupingUsed
public boolean isGroupingUsed()
- Returns:
-
trueif grouping is used;falseotherwise - See Also:
setGroupingUsed
public void setGroupingUsed(boolean newValue)
- Parameters:
-
newValue-trueif grouping is used;falseotherwise - See Also:
getMaximumIntegerDigits
public int getMaximumIntegerDigits()
- Returns:
- the maximum number of digits
- See Also:
setMaximumIntegerDigits
public void setMaximumIntegerDigits(int newValue)
- Parameters:
-
newValue- the maximum number of integer digits to be shown; if less than zero, then zero is used. The concrete subclass may enforce an upper limit to this value appropriate to the numeric type being formatted. - See Also:
getMinimumIntegerDigits
public int getMinimumIntegerDigits()
- Returns:
- the minimum number of digits
- See Also:
setMinimumIntegerDigits
public void setMinimumIntegerDigits(int newValue)
- Parameters:
-
newValue- the minimum number of integer digits to be shown; if less than zero, then zero is used. The concrete subclass may enforce an upper limit to this value appropriate to the numeric type being formatted. - See Also:
getMaximumFractionDigits
public int getMaximumFractionDigits()
- Returns:
- the maximum number of digits.
- See Also:
setMaximumFractionDigits
public void setMaximumFractionDigits(int newValue)
- Parameters:
-
newValue- the maximum number of fraction digits to be shown; if less than zero, then zero is used. The concrete subclass may enforce an upper limit to this value appropriate to the numeric type being formatted. - See Also:
getMinimumFractionDigits
public int getMinimumFractionDigits()
- Returns:
- the minimum number of digits
- See Also:
setMinimumFractionDigits
public void setMinimumFractionDigits(int newValue)
- Parameters:
-
newValue- the minimum number of fraction digits to be shown; if less than zero, then zero is used. The concrete subclass may enforce an upper limit to this value appropriate to the numeric type being formatted. - See Also:
getCurrency
public Currency getCurrency()
setCurrency. The default implementation throws UnsupportedOperationException.
- Returns:
- the currency used by this number format, or
null - Throws:
-
UnsupportedOperationException- if the number format class doesn't implement currency formatting - Since:
- 1.4
setCurrency
public void setCurrency(Currency currency)
The default implementation throws UnsupportedOperationException.
- Parameters:
-
currency- the new currency to be used by this number format - Throws:
-
UnsupportedOperationException- if the number format class doesn't implement currency formatting -
NullPointerException- ifcurrencyis null - Since:
- 1.4
getRoundingMode
public RoundingMode getRoundingMode()
RoundingMode used in this NumberFormat. The default implementation of this method in NumberFormat always throws UnsupportedOperationException. Subclasses which handle different rounding modes should override this method.- Returns:
- The
RoundingModeused for this NumberFormat. - Throws:
-
UnsupportedOperationException- The default implementation always throws this exception - Since:
- 1.6
- See Also:
setRoundingMode
public void setRoundingMode(RoundingMode roundingMode)
RoundingMode used in this NumberFormat. The default implementation of this method in NumberFormat always throws UnsupportedOperationException. Subclasses which handle different rounding modes should override this method.- Parameters:
-
roundingMode- TheRoundingModeto be used - Throws:
-
UnsupportedOperationException- The default implementation always throws this exception -
NullPointerException- ifroundingModeis null - Since:
- 1.6
- See Also:
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/text/NumberFormat.html