Class NumberFormat
- All Implemented Interfaces:
Serializable
,Cloneable
- Direct Known Subclasses:
DecimalFormat
,RuleBasedNumberFormat
IMPORTANT: New users are strongly encouraged to see if
NumberFormatter
fits their use case. Although not deprecated, this
class, NumberFormat, is only provided for java.text.NumberFormat compatibility.
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 < a.length; ++i) { output.println(nf.format(myNumber[i]) + "; "); }
getInstance
.
You can also use aNumberFormat nf = NumberFormat.getInstance(Locale.FRENCH);
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. And use getPercentInstance
to get a
format for displaying percentages. Some factory methods are found within
subclasses of NumberFormat. With this format, a fraction like
0.53 is displayed as 53%.
Starting from ICU 4.2, you can use getInstance() by passing in a 'style' as parameter to get the correct instance. For example, use getInstance(...NUMBERSTYLE) to get the normal number format, getInstance(...PERCENTSTYLE) to get a format for displaying percentage, getInstance(...SCIENTIFICSTYLE) to get a format for displaying scientific number, getInstance(...INTEGERSTYLE) to get an integer number format, getInstance(...CURRENCYSTYLE) to get the currency number format, in which the currency is represented by its symbol, for example, "$3.00". getInstance(...ISOCURRENCYSTYLE) to get the currency number format, in which the currency is represented by its ISO code, for example "USD3.00". getInstance(...PLURALCURRENCYSTYLE) to get the currency number format, in which the currency is represented by its full name in plural format, for example, "3.00 US dollars" or "1.00 US dollar".
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
. 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 is 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 '6') if false, "3456.78" -> 3456.78 (and leaves the parse position just after '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 on DecimalFormat.
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
FieldPosition
in your format call, withfield
=INTEGER_FIELD
. On output,getEndIndex
will 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.
DecimalFormat
DecimalFormat is the concrete implementation of NumberFormat, and the NumberFormat API is essentially an abstraction from DecimalFormat's API. Refer to DecimalFormat for more information about this API.
see DecimalFormat see java.text.ChoiceFormat- Author:
- Mark Davis, Helena Shih, Alan Liu
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
The instances of this inner class are used as attribute keys and values in AttributedCharacterIterator that NumberFormat.formatToCharacterIterator() method returns.static class
A NumberFormatFactory is used to register new number formats.static class
A NumberFormatFactory that supports a single locale.Nested classes/interfaces inherited from class com.ibm.icu.text.UFormat
UFormat.SpanField
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Constant to specify currency style of format which uses currency symbol to represent currency for accounting, for example: "($3.00), instead of "-$3.00" (CURRENCYSTYLE
).static final int
Constant to specify currency cash style of format which uses currency ISO code to represent currency, for example: "NT$3" instead of "NT$3.23".static final int
Constant to specify general currency style of format.static final int
Field constant used to construct a FieldPosition object.static final int
Field constant used to construct a FieldPosition object.static final int
Constant to specify a integer number style format.static final int
Constant to specify currency style of format which uses currency ISO code to represent currency, for example: "USD3.00".static final int
Constant to specify normal number style of format.static final int
Constant to specify a style of format to display percent.static final int
Constant to specify currency style of format which uses currency long name with plural format to represent currency, for example, "3.00 US Dollars".static final int
Constant to specify a style of format to display scientific number.static final int
Constant to specify currency style of format which uses currency symbol to represent currency, for example "$3.00", using non-accounting style for negative values (e.g. minus sign). -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Overrides clone.boolean
Overrides equals.final String
format
(double number) Specialization of format.abstract StringBuffer
format
(double number, StringBuffer toAppendTo, FieldPosition pos) Specialization of format.final String
format
(long number) Specialization of format.abstract StringBuffer
format
(long number, StringBuffer toAppendTo, FieldPosition pos) Specialization of format.final String
format
(BigDecimal number) Convenience method to format an ICU BigDecimal.abstract StringBuffer
format
(BigDecimal number, StringBuffer toAppendTo, FieldPosition pos) Formats an ICU BigDecimal.final String
format
(CurrencyAmount currAmt) Convenience method to format a CurrencyAmount.format
(CurrencyAmount currAmt, StringBuffer toAppendTo, FieldPosition pos) Formats a CurrencyAmount.format
(Object number, StringBuffer toAppendTo, FieldPosition pos) Formats a number and appends the resulting text to the given string buffer.final String
format
(BigDecimal number) Convenience method to format a BigDecimal.abstract StringBuffer
format
(BigDecimal number, StringBuffer toAppendTo, FieldPosition pos) Formats a BigDecimal.final String
format
(BigInteger number) Convenience method to format a BigInteger.abstract StringBuffer
format
(BigInteger number, StringBuffer toAppendTo, FieldPosition pos) Formats a BigInteger.static Locale[]
Returns the list of Locales for which NumberFormats are available.static ULocale[]
Returns the list of Locales for which NumberFormats are available.Get the formatter's DisplayContext value for the specified DisplayContext.Type, such as CAPITALIZATION.Returns the Currency object used to display currency amounts.static final NumberFormat
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static NumberFormat
getCurrencyInstance
(ULocale inLocale) NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static NumberFormat
getCurrencyInstance
(Locale inLocale) NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.protected Currency
Deprecated.This API is ICU internal only.static final NumberFormat
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static final NumberFormat
getInstance
(int style) NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static NumberFormat
getInstance
(ULocale inLocale) NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static NumberFormat
getInstance
(ULocale desiredLocale, int choice) NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static NumberFormat
getInstance
(Locale inLocale) NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static NumberFormat
getInstance
(Locale inLocale, int style) NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static final NumberFormat
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static NumberFormat
getIntegerInstance
(ULocale inLocale) NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static NumberFormat
getIntegerInstance
(Locale inLocale) NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.int
Returns the maximum number of digits allowed in the fraction portion of a number.int
Returns the maximum number of digits allowed in the integer portion of a number.int
Returns the minimum number of digits allowed in the fraction portion of a number.int
Returns the minimum number of digits allowed in the integer portion of a number.static final NumberFormat
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static NumberFormat
getNumberInstance
(ULocale inLocale) NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static NumberFormat
getNumberInstance
(Locale inLocale) NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.protected static String
getPattern
(ULocale forLocale, int choice) Returns the pattern for the provided locale and choice.protected static String
getPattern
(Locale forLocale, int choice) Deprecated.ICU 3.4 subclassers should override getPattern(ULocale, int) instead of this method.static String
getPatternForStyle
(ULocale forLocale, int choice) Deprecated.This API is ICU internal only.static String
getPatternForStyleAndNumberingSystem
(ULocale forLocale, String nsName, int choice) Deprecated.This API is ICU internal only.static final NumberFormat
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static NumberFormat
getPercentInstance
(ULocale inLocale) NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static NumberFormat
getPercentInstance
(Locale inLocale) NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.int
Returns the rounding mode used in this NumberFormat.static final NumberFormat
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static NumberFormat
getScientificInstance
(ULocale inLocale) NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static NumberFormat
getScientificInstance
(Locale inLocale) NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.int
hashCode()
boolean
Returns true if grouping is used in this format.boolean
Returns true if this format will parse numbers as integers only.boolean
Returns whether strict parsing is in effect.Parses text from the beginning of the given string to produce a number.abstract Number
parse
(String text, ParsePosition parsePosition) Returns a Long if possible (e.g., within the range [Long.MIN_VALUE, Long.MAX_VALUE] and with no decimals); otherwise, returns another type, such as a BigDecimal, BigInteger, or Double.parseCurrency
(CharSequence text, ParsePosition pos) Parses text from the given string as a CurrencyAmount.final Object
parseObject
(String source, ParsePosition parsePosition) Parses text from a string to produce a number.static Object
Registers a new NumberFormatFactory.void
setContext
(DisplayContext context) Set a particular DisplayContext value in the formatter, such as CAPITALIZATION_FOR_STANDALONE.void
setCurrency
(Currency theCurrency) Sets the Currency object used to display currency amounts.void
setGroupingUsed
(boolean newValue) Sets whether or not grouping will be used in this format.void
setMaximumFractionDigits
(int newValue) Sets the maximum number of digits allowed in the fraction portion of a number.void
setMaximumIntegerDigits
(int newValue) Sets the maximum number of digits allowed in the integer portion of a number.void
setMinimumFractionDigits
(int newValue) Sets the minimum number of digits allowed in the fraction portion of a number.void
setMinimumIntegerDigits
(int newValue) Sets the minimum number of digits allowed in the integer portion of a number.void
setParseIntegerOnly
(boolean value) Sets whether to ignore the fraction part of a number when parsing (defaults to false).void
setParseStrict
(boolean value) Sets whether strict parsing is in effect.void
setRoundingMode
(int roundingMode) Set the rounding mode used in this NumberFormat.static boolean
unregister
(Object registryKey) Unregisters the factory or instance associated with this key (obtained from registerInstance or registerFactory).Methods inherited from class java.text.Format
format, formatToCharacterIterator, parseObject
-
Field Details
-
NUMBERSTYLE
public static final int NUMBERSTYLEConstant to specify normal number style of format.- See Also:
-
CURRENCYSTYLE
public static final int CURRENCYSTYLEConstant to specify general currency style of format. Defaults to STANDARDCURRENCYSTYLE, using currency symbol, for example "$3.00", with non-accounting style for negative values (e.g. minus sign). The specific style may be specified using the -cf- locale key.- See Also:
-
PERCENTSTYLE
public static final int PERCENTSTYLEConstant to specify a style of format to display percent.- See Also:
-
SCIENTIFICSTYLE
public static final int SCIENTIFICSTYLEConstant to specify a style of format to display scientific number.- See Also:
-
INTEGERSTYLE
public static final int INTEGERSTYLEConstant to specify a integer number style format.- See Also:
-
ISOCURRENCYSTYLE
public static final int ISOCURRENCYSTYLEConstant to specify currency style of format which uses currency ISO code to represent currency, for example: "USD3.00".- See Also:
-
PLURALCURRENCYSTYLE
public static final int PLURALCURRENCYSTYLEConstant to specify currency style of format which uses currency long name with plural format to represent currency, for example, "3.00 US Dollars".- See Also:
-
ACCOUNTINGCURRENCYSTYLE
public static final int ACCOUNTINGCURRENCYSTYLEConstant to specify currency style of format which uses currency symbol to represent currency for accounting, for example: "($3.00), instead of "-$3.00" (CURRENCYSTYLE
). Overrides any style specified using -cf- key in locale.- See Also:
-
CASHCURRENCYSTYLE
public static final int CASHCURRENCYSTYLEConstant to specify currency cash style of format which uses currency ISO code to represent currency, for example: "NT$3" instead of "NT$3.23".- See Also:
-
STANDARDCURRENCYSTYLE
public static final int STANDARDCURRENCYSTYLEConstant to specify currency style of format which uses currency symbol to represent currency, for example "$3.00", using non-accounting style for negative values (e.g. minus sign). Overrides any style specified using -cf- key in locale.- See Also:
-
INTEGER_FIELD
public static final int INTEGER_FIELDField constant used to construct a FieldPosition object. Signifies that the position of the integer part of a formatted number should be returned.- See Also:
-
FRACTION_FIELD
public static final int FRACTION_FIELDField constant used to construct a FieldPosition object. Signifies that the position of the fraction part of a formatted number should be returned.- See Also:
-
-
Constructor Details
-
NumberFormat
public NumberFormat()Empty constructor. Public for API compatibility with historic versions ofNumberFormat
which had public constructor even though this is an abstract class.
-
-
Method Details
-
format
Formats a number and appends the resulting text to the given string buffer. recognizesBigInteger
andBigDecimal
objects. -
parseObject
Parses text from a string to produce a number.- Specified by:
parseObject
in classFormat
- Parameters:
source
- the String to parseparsePosition
- the position at which to start the parse- Returns:
- the parsed number, or null
- See Also:
-
format
Specialization of format.- See Also:
-
format
Specialization of format.- See Also:
-
format
Convenience method to format a BigInteger. -
format
Convenience method to format a BigDecimal. -
format
Convenience method to format an ICU BigDecimal. -
format
Convenience method to format a CurrencyAmount. -
format
Specialization of format.- See Also:
-
format
Specialization of format.- See Also:
-
format
Formats a BigInteger. Specialization of format.- See Also:
-
format
Formats a BigDecimal. Specialization of format.- See Also:
-
format
Formats an ICU BigDecimal. Specialization of format.- See Also:
-
format
Formats a CurrencyAmount. Specialization of format.- See Also:
-
parse
Returns a Long if possible (e.g., within the range [Long.MIN_VALUE, Long.MAX_VALUE] and with no decimals); otherwise, returns another type, such as a BigDecimal, BigInteger, or Double. The return type is not guaranteed other than for the Long case.If IntegerOnly is set, will stop at a decimal point (or equivalent; e.g., for rational numbers "1 2/3", will stop after the 1).
Does not throw an exception; if no object can be parsed, index is unchanged!
For more detail on parsing, see the "Parsing" header in the class documentation of
DecimalFormat
.- See Also:
-
parse
Parses text from the beginning of the given string to produce a number. The method might not use the entire text of the given string.- Parameters:
text
- A String whose beginning should be parsed.- Returns:
- A Number parsed from the string.
- Throws:
ParseException
- if the beginning of the specified string cannot be parsed.- See Also:
-
parseCurrency
Parses text from the given string as a CurrencyAmount. Unlike the parse() method, this method will attempt to parse a generic currency name, searching for a match of this object's locale's currency display names, or for a 3-letter ISO currency code. This method will fail if this format is not a currency format, that is, if it does not contain the currency pattern symbol (U+00A4) in its prefix or suffix.- Parameters:
text
- the text to parsepos
- input-output position; on input, the position within text to match; must have 0 <= pos.getIndex() < text.length(); on output, the position after the last matched character. If the parse fails, the position in unchanged upon output.- Returns:
- a CurrencyAmount, or null upon failure
-
isParseIntegerOnly
public boolean isParseIntegerOnly()Returns true if this format will parse numbers as integers only. For example in the English locale, with ParseIntegerOnly true, the string "1234." would be parsed as the integer value 1234 and parsing would stop at the "." character. The decimal separator accepted by the parse operation is locale-dependent and determined by the subclass.- Returns:
- true if this will parse integers only
-
setParseIntegerOnly
public void setParseIntegerOnly(boolean value) Sets whether to ignore the fraction part of a number when parsing (defaults to false). If a string contains a decimal point, parsing will stop before the decimal point. Note that determining whether a character is a decimal point depends on the locale.For example, in en-US, parsing the string "123.45" will return the number 123 and parse position 3.
- Parameters:
value
- true if this should parse integers only- See Also:
-
setParseStrict
public void setParseStrict(boolean value) Sets whether strict parsing is in effect. When this is true, the string is required to be a stronger match to the pattern than when lenient parsing is in effect. More specifically, the following conditions cause a parse failure relative to lenient mode (examples use the pattern "#,##0.#"):- The presence and position of special symbols, including currency, must match the
pattern.
'+123' fails (there is no plus sign in the pattern) - Leading or doubled grouping separators
',123' and '1,,234" fail - Groups of incorrect length when grouping is used
'1,23' and '1234,567' fail, but '1234' passes - Grouping separators used in numbers followed by exponents
'1,234E5' fails, but '1234E5' and '1,234E' pass ('E' is not an exponent when not followed by a number)
- Parameters:
value
- True to enable strict parsing. Default is false.- See Also:
- The presence and position of special symbols, including currency, must match the
pattern.
-
isParseStrict
public boolean isParseStrict()Returns whether strict parsing is in effect.- Returns:
- true if strict parsing is in effect
- See Also:
-
setContext
Set a particular DisplayContext value in the formatter, such as CAPITALIZATION_FOR_STANDALONE.- Parameters:
context
- The DisplayContext value to set.
-
getContext
Get the formatter's DisplayContext value for the specified DisplayContext.Type, such as CAPITALIZATION.- Parameters:
type
- the DisplayContext.Type whose value to return- Returns:
- the current DisplayContext setting for the specified type
-
getInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns the default number format for the current defaultFORMAT
locale. The default format is one of the styles provided by the other factory methods: getNumberInstance, getIntegerInstance, getCurrencyInstance or getPercentInstance. Exactly which one is locale-dependent.- See Also:
-
getInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns the default number format for the specified locale. The default format is one of the styles provided by the other factory methods: getNumberInstance, getCurrencyInstance or getPercentInstance. Exactly which one is locale-dependent. -
getInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns the default number format for the specified locale. The default format is one of the styles provided by the other factory methods: getNumberInstance, getCurrencyInstance or getPercentInstance. Exactly which one is locale-dependent. -
getInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns a specific style number format for defaultFORMAT
locale.- Parameters:
style
- number format style- See Also:
-
getInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns a specific style number format for a specific locale.- Parameters:
inLocale
- the specific locale.style
- number format style
-
getNumberInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns a general-purpose number format for the current defaultFORMAT
locale.- See Also:
-
getNumberInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns a general-purpose number format for the specified locale. -
getNumberInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns a general-purpose number format for the specified locale. -
getIntegerInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns an integer number format for the current defaultFORMAT
locale. The returned number format is configured to round floating point numbers to the nearest integer using IEEE half-even rounding (seeROUND_HALF_EVEN
) for formatting, and to parse only the integer part of an input string (seeisParseIntegerOnly
).- Returns:
- a number format for integer values
- See Also:
-
getIntegerInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns an integer number format for the specified locale. The returned number format is configured to round floating point numbers to the nearest integer using IEEE half-even rounding (seeROUND_HALF_EVEN
) for formatting, and to parse only the integer part of an input string (seeisParseIntegerOnly
).- Parameters:
inLocale
- the locale for which a number format is needed- Returns:
- a number format for integer values
-
getIntegerInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns an integer number format for the specified locale. The returned number format is configured to round floating point numbers to the nearest integer using IEEE half-even rounding (seeROUND_HALF_EVEN
) for formatting, and to parse only the integer part of an input string (seeisParseIntegerOnly
).- Parameters:
inLocale
- the locale for which a number format is needed- Returns:
- a number format for integer values
-
getCurrencyInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns a currency format for the current defaultFORMAT
locale.- Returns:
- a number format for currency
- See Also:
-
getCurrencyInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns a currency format for the specified locale.- Returns:
- a number format for currency
-
getCurrencyInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns a currency format for the specified locale.- Returns:
- a number format for currency
-
getPercentInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns a percentage format for the current defaultFORMAT
locale.- Returns:
- a number format for percents
- See Also:
-
getPercentInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns a percentage format for the specified locale.- Returns:
- a number format for percents
-
getPercentInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns a percentage format for the specified locale.- Returns:
- a number format for percents
-
getScientificInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns a scientific format for the current defaultFORMAT
locale.- Returns:
- a scientific number format
- See Also:
-
getScientificInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns a scientific format for the specified locale.- Returns:
- a scientific number format
-
getScientificInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns a scientific format for the specified locale.- Returns:
- a scientific number format
-
getAvailableLocales
Returns the list of Locales for which NumberFormats are available.- Returns:
- the available locales
-
getAvailableULocales
Returns the list of Locales for which NumberFormats are available.- Returns:
- the available locales
-
registerFactory
Registers a new NumberFormatFactory. The factory is adopted by the service and must not be modified. The returned object is a key that can be used to unregister this factory.Because ICU may choose to cache NumberFormat objects internally, this must be called at application startup, prior to any calls to NumberFormat.getInstance to avoid undefined behavior.
- Parameters:
factory
- the factory to register- Returns:
- a key with which to unregister the factory
-
unregister
Unregisters the factory or instance associated with this key (obtained from registerInstance or registerFactory).- Parameters:
registryKey
- a key obtained from registerFactory- Returns:
- true if the object was successfully unregistered
-
hashCode
public int hashCode() -
equals
Overrides equals. Two NumberFormats are equal they are of the same class and the user-specified values for settings (groupingUsed, parseIntegerOnly, maximumIntegerDigits, etc.) are equal. -
clone
Overrides clone. -
isGroupingUsed
public boolean isGroupingUsed()Returns true if grouping is used in this format. For example, in the en_US locale, with grouping on, the number 1234567 will be formatted as "1,234,567". The grouping separator as well as the size of each group is locale-dependent and is determined by subclasses of NumberFormat. Grouping affects both parsing and formatting.- Returns:
- true if grouping is used
- See Also:
-
setGroupingUsed
public void setGroupingUsed(boolean newValue) Sets whether or not grouping will be used in this format. Grouping affects both parsing and formatting.- Parameters:
newValue
- true to use grouping.- See Also:
-
getMaximumIntegerDigits
public int getMaximumIntegerDigits()Returns the maximum number of digits allowed in the integer portion of a number. The default value is 40, which subclasses can override. When formatting, if the number of digits exceeds this value, the highest- significance digits are truncated until the limit is reached, in accordance with UTS#35. This setting has no effect on parsing.- Returns:
- the maximum number of integer digits
- See Also:
-
setMaximumIntegerDigits
public void setMaximumIntegerDigits(int newValue) Sets the maximum number of digits allowed in the integer portion of a number. This must be >= minimumIntegerDigits. If the new value for maximumIntegerDigits is less than the current value of minimumIntegerDigits, then minimumIntegerDigits will also be set to the new value.- Parameters:
newValue
- the maximum number of integer digits to be shown; if less than zero, then zero is used. Subclasses might 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 allowed in the integer portion of a number. The default value is 1, which subclasses can override. When formatting, if this value is not reached, numbers are padded on the left with the locale-specific '0' character to ensure at least this number of integer digits. When parsing, this has no effect.- Returns:
- the minimum number of integer digits
- See Also:
-
setMinimumIntegerDigits
public void setMinimumIntegerDigits(int newValue) Sets the minimum number of digits allowed in the integer portion of a number. This must be <= maximumIntegerDigits. If the new value for minimumIntegerDigits is more than the current value of maximumIntegerDigits, then maximumIntegerDigits will also be set to the new value.- Parameters:
newValue
- the minimum number of integer digits to be shown; if less than zero, then zero is used. Subclasses might 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 allowed in the fraction portion of a number. The default value is 3, which subclasses can override. When formatting, the exact behavior when this value is exceeded is subclass-specific. When parsing, this has no effect.- Returns:
- the maximum number of fraction digits
- See Also:
-
setMaximumFractionDigits
public void setMaximumFractionDigits(int newValue) Sets the maximum number of digits allowed in the fraction portion of a number. This must be >= minimumFractionDigits. If the new value for maximumFractionDigits is less than the current value of minimumFractionDigits, then minimumFractionDigits will also be set to the new value.- 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 allowed in the fraction portion of a number. The default value is 0, which subclasses can override. When formatting, if this value is not reached, numbers are padded on the right with the locale-specific '0' character to ensure at least this number of fraction digits. When parsing, this has no effect.- Returns:
- the minimum number of fraction digits
- See Also:
-
setMinimumFractionDigits
public void setMinimumFractionDigits(int newValue) Sets the minimum number of digits allowed in the fraction portion of a number. This must be <= maximumFractionDigits. If the new value for minimumFractionDigits exceeds the current value of maximumFractionDigits, then maximumFractionDigits will also be set to the new value.- Parameters:
newValue
- the minimum number of fraction digits to be shown; if less than zero, then zero is used. Subclasses might enforce an upper limit to this value appropriate to the numeric type being formatted.- See Also:
-
setCurrency
Sets the Currency object used to display currency amounts. This takes effect immediately, if this format is a currency format. If this format is not a currency format, then the currency object is used if and when this object becomes a currency format.- Parameters:
theCurrency
- new currency object to use. May be null for some subclasses.
-
getCurrency
Returns the Currency object used to display currency amounts. This may be null. -
getEffectiveCurrency
Deprecated.This API is ICU internal only.Returns the currency in effect for this formatter. Subclasses should override this method as needed. Unlike getCurrency(), this method should never return null.- Returns:
- a non-null Currency
-
getRoundingMode
public int getRoundingMode()Returns the rounding mode used in this NumberFormat. The default implementation of tis method in NumberFormat always throwsUnsupportedOperationException
.- Returns:
- A rounding mode, between
BigDecimal.ROUND_UP
andBigDecimal.ROUND_UNNECESSARY
. - See Also:
-
setRoundingMode
public void setRoundingMode(int roundingMode) Set the rounding mode used in this NumberFormat. The default implementation of tis method in NumberFormat always throwsUnsupportedOperationException
.- Parameters:
roundingMode
- A rounding mode, betweenBigDecimal.ROUND_UP
andBigDecimal.ROUND_UNNECESSARY
.- See Also:
-
getInstance
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns a specific style number format for a specific locale.- Parameters:
desiredLocale
- the specific locale.choice
- number format style- Throws:
IllegalArgumentException
- if choice is not one of NUMBERSTYLE, CURRENCYSTYLE, PERCENTSTYLE, SCIENTIFICSTYLE, INTEGERSTYLE, ISOCURRENCYSTYLE, PLURALCURRENCYSTYLE, ACCOUNTINGCURRENCYSTYLE. CASHCURRENCYSTYLE, STANDARDCURRENCYSTYLE.
-
getPattern
Deprecated.ICU 3.4 subclassers should override getPattern(ULocale, int) instead of this method.Returns the pattern for the provided locale and choice.- Parameters:
forLocale
- the locale of the data.choice
- the pattern format.- Returns:
- the pattern
-
getPattern
Returns the pattern for the provided locale and choice.- Parameters:
forLocale
- the locale of the data.choice
- the pattern format.- Returns:
- the pattern
-
getPatternForStyle
Deprecated.This API is ICU internal only.Returns the pattern for the provided locale and choice.- Parameters:
forLocale
- the locale of the data.choice
- the pattern format.- Returns:
- the pattern
-
getPatternForStyleAndNumberingSystem
@Deprecated public static String getPatternForStyleAndNumberingSystem(ULocale forLocale, String nsName, int choice) Deprecated.This API is ICU internal only.Returns the pattern for the provided locale, numbering system, and choice.- Parameters:
forLocale
- the locale of the data.nsName
- The name of the numbering system, like "latn".choice
- the pattern format.- Returns:
- the pattern
-