Class NumberFormat
- java.lang.Object
-
- java.text.Format
-
- com.ibm.icu.text.UFormat
-
- com.ibm.icu.text.NumberFormat
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
- Direct Known Subclasses:
DateNumberFormat
,DecimalFormat
,NumberFormatJDK
,RuleBasedNumberFormat
public abstract class NumberFormat extends UFormat
.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:
myString = NumberFormat.getInstance().format(myNumber);
NumberFormat nf = NumberFormat.getInstance(); for (int i = 0; i < a.length; ++i) { output.println(nf.format(myNumber[i]) + "; "); }
getInstance
.NumberFormat nf = NumberFormat.getInstance(Locale.FRENCH);
NumberFormat
to parse numbers:myNumber = nf.parse(myString);
getInstance
orgetNumberInstance
to get the normal number format. UsegetIntegerInstance
to get an integer number format. UsegetCurrencyInstance
to get the currency number format. And usegetPercentInstance
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 theNumberFormat
you get from the factory methods to aDecimalFormat
. This will work for the vast majority of locales; just remember to put it in atry
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
andformat
methods withParsePosition
andFieldPosition
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- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
NumberFormat.Field
The instances of this inner class are used as attribute keys and values in AttributedCharacterIterator that NumberFormat.formatToCharacterIterator() method returns.static class
NumberFormat.NumberFormatFactory
A NumberFormatFactory is used to register new number formats.(package private) static class
NumberFormat.NumberFormatShim
static class
NumberFormat.SimpleNumberFormatFactory
A NumberFormatFactory that supports a single locale.-
Nested classes/interfaces inherited from class com.ibm.icu.text.UFormat
UFormat.SpanField
-
-
Field Summary
Fields Modifier and Type Field Description static int
ACCOUNTINGCURRENCYSTYLE
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
).private DisplayContext
capitalizationSetting
static int
CASHCURRENCYSTYLE
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".private Currency
currency
Currency object used to format currencies.static int
CURRENCYSTYLE
Constant to specify general currency style of format.(package private) static int
currentSerialVersion
private static char[]
doubleCurrencySign
private static java.lang.String
doubleCurrencyStr
static int
FRACTION_FIELD
Field constant used to construct a FieldPosition object.private boolean
groupingUsed
True if the the grouping (i.e.static int
INTEGER_FIELD
Field constant used to construct a FieldPosition object.static int
INTEGERSTYLE
Constant to specify a integer number style format.static int
ISOCURRENCYSTYLE
Constant to specify currency style of format which uses currency ISO code to represent currency, for example: "USD3.00".private byte
maxFractionDigits
The maximum number of digits allowed in the fractional portion of a number.private int
maximumFractionDigits
The maximum number of digits allowed in the fractional portion of a number.private int
maximumIntegerDigits
The maximum number of digits allowed in the integer portion of a number.private byte
maxIntegerDigits
The maximum number of digits allowed in the integer portion of a number.private byte
minFractionDigits
The minimum number of digits allowed in the fractional portion of a number.private int
minimumFractionDigits
The minimum number of digits allowed in the fractional portion of a number.private int
minimumIntegerDigits
The minimum number of digits allowed in the integer portion of a number.private byte
minIntegerDigits
The minimum number of digits allowed in the integer portion of a number.static int
NUMBERSTYLE
Constant to specify normal number style of format.private boolean
parseIntegerOnly
True if this format will parse numbers as integers only.private boolean
parseStrict
static int
PERCENTSTYLE
Constant to specify a style of format to display percent.static int
PLURALCURRENCYSTYLE
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 int
SCIENTIFICSTYLE
Constant to specify a style of format to display scientific number.private int
serialVersionOnStream
Describes the version ofNumberFormat
present on the stream.private static long
serialVersionUID
private static NumberFormat.NumberFormatShim
shim
static int
STANDARDCURRENCYSTYLE
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.
-
Constructor Summary
Constructors Constructor Description NumberFormat()
Empty constructor.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.Object
clone()
Overrides clone.(package private) static NumberFormat
createInstance(ULocale desiredLocale, int choice)
boolean
equals(java.lang.Object obj)
Overrides equals.java.lang.String
format(double number)
Specialization of format.abstract java.lang.StringBuffer
format(double number, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
Specialization of format.java.lang.String
format(long number)
Specialization of format.abstract java.lang.StringBuffer
format(long number, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
Specialization of format.java.lang.String
format(BigDecimal number)
Convenience method to format an ICU BigDecimal.abstract java.lang.StringBuffer
format(BigDecimal number, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
Formats an ICU BigDecimal.java.lang.String
format(CurrencyAmount currAmt)
Convenience method to format a CurrencyAmount.java.lang.StringBuffer
format(CurrencyAmount currAmt, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
Formats a CurrencyAmount.java.lang.StringBuffer
format(java.lang.Object number, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
Formats a number and appends the resulting text to the given string buffer.java.lang.String
format(java.math.BigDecimal number)
Convenience method to format a BigDecimal.abstract java.lang.StringBuffer
format(java.math.BigDecimal number, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
Formats a BigDecimal.java.lang.String
format(java.math.BigInteger number)
Convenience method to format a BigInteger.abstract java.lang.StringBuffer
format(java.math.BigInteger number, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
Formats a BigInteger.static java.util.Locale[]
getAvailableLocales()
Returns the list of Locales for which NumberFormats are available.static ULocale[]
getAvailableULocales()
Returns the list of Locales for which NumberFormats are available.DisplayContext
getContext(DisplayContext.Type type)
Get the formatter's DisplayContext value for the specified DisplayContext.Type, such as CAPITALIZATION.Currency
getCurrency()
Returns the Currency object used to display currency amounts.static NumberFormat
getCurrencyInstance()
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(java.util.Locale inLocale)
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.protected Currency
getEffectiveCurrency()
Deprecated.This API is ICU internal only.static NumberFormat
getInstance()
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static 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(java.util.Locale inLocale)
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static NumberFormat
getInstance(java.util.Locale inLocale, int style)
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.static NumberFormat
getIntegerInstance()
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(java.util.Locale inLocale)
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.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 NumberFormat
getNumberInstance()
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(java.util.Locale inLocale)
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.protected static java.lang.String
getPattern(ULocale forLocale, int choice)
Returns the pattern for the provided locale and choice.protected static java.lang.String
getPattern(java.util.Locale forLocale, int choice)
Deprecated.ICU 3.4 subclassers should override getPattern(ULocale, int) instead of this method.static java.lang.String
getPatternForStyle(ULocale forLocale, int choice)
Deprecated.This API is ICU internal only.static java.lang.String
getPatternForStyleAndNumberingSystem(ULocale forLocale, java.lang.String nsName, int choice)
Deprecated.This API is ICU internal only.static NumberFormat
getPercentInstance()
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(java.util.Locale inLocale)
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.int
getRoundingMode()
Returns the rounding mode used in this NumberFormat.static NumberFormat
getScientificInstance()
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(java.util.Locale inLocale)
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.private static NumberFormat.NumberFormatShim
getShim()
int
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.boolean
isParseStrict()
Returns whether strict parsing is in effect.java.lang.Number
parse(java.lang.String text)
Parses text from the beginning of the given string to produce a number.abstract java.lang.Number
parse(java.lang.String text, java.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.CurrencyAmount
parseCurrency(java.lang.CharSequence text, java.text.ParsePosition pos)
Parses text from the given string as a CurrencyAmount.java.lang.Object
parseObject(java.lang.String source, java.text.ParsePosition parsePosition)
Parses text from a string to produce a number.private void
readObject(java.io.ObjectInputStream stream)
First, read in the default serializable data.static java.lang.Object
registerFactory(NumberFormat.NumberFormatFactory factory)
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(java.lang.Object registryKey)
Unregisters the factory or instance associated with this key (obtained from registerInstance or registerFactory).private void
writeObject(java.io.ObjectOutputStream stream)
Write out the default serializable data, after first setting thebyte
fields such asmaxIntegerDigits
to be equal to theint
fields such asmaximumIntegerDigits
(or toByte.MAX_VALUE
, whichever is smaller), for compatibility with the JDK 1.1 version of the stream format.
-
-
-
Field Detail
-
NUMBERSTYLE
public static final int NUMBERSTYLE
Constant to specify normal number style of format.- See Also:
- Constant Field Values
-
CURRENCYSTYLE
public static final int CURRENCYSTYLE
Constant 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:
- Constant Field Values
-
PERCENTSTYLE
public static final int PERCENTSTYLE
Constant to specify a style of format to display percent.- See Also:
- Constant Field Values
-
SCIENTIFICSTYLE
public static final int SCIENTIFICSTYLE
Constant to specify a style of format to display scientific number.- See Also:
- Constant Field Values
-
INTEGERSTYLE
public static final int INTEGERSTYLE
Constant to specify a integer number style format.- See Also:
- Constant Field Values
-
ISOCURRENCYSTYLE
public static final int ISOCURRENCYSTYLE
Constant to specify currency style of format which uses currency ISO code to represent currency, for example: "USD3.00".- See Also:
- Constant Field Values
-
PLURALCURRENCYSTYLE
public static final int PLURALCURRENCYSTYLE
Constant 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:
- Constant Field Values
-
ACCOUNTINGCURRENCYSTYLE
public static final int ACCOUNTINGCURRENCYSTYLE
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
). Overrides any style specified using -cf- key in locale.- See Also:
- Constant Field Values
-
CASHCURRENCYSTYLE
public static final int CASHCURRENCYSTYLE
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".- See Also:
- Constant Field Values
-
STANDARDCURRENCYSTYLE
public static final int STANDARDCURRENCYSTYLE
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). Overrides any style specified using -cf- key in locale.- See Also:
- Constant Field Values
-
INTEGER_FIELD
public static final int INTEGER_FIELD
Field constant used to construct a FieldPosition object. Signifies that the position of the integer part of a formatted number should be returned.- See Also:
FieldPosition
, Constant Field Values
-
FRACTION_FIELD
public static final int FRACTION_FIELD
Field constant used to construct a FieldPosition object. Signifies that the position of the fraction part of a formatted number should be returned.- See Also:
FieldPosition
, Constant Field Values
-
shim
private static NumberFormat.NumberFormatShim shim
-
doubleCurrencySign
private static final char[] doubleCurrencySign
-
doubleCurrencyStr
private static final java.lang.String doubleCurrencyStr
-
groupingUsed
private boolean groupingUsed
True if the the grouping (i.e. thousands) separator is used when formatting and parsing numbers.- See Also:
isGroupingUsed()
-
maxIntegerDigits
private byte maxIntegerDigits
The maximum number of digits allowed in the integer portion of a number.maxIntegerDigits
must be greater than or equal tominIntegerDigits
.Note: This field exists only for serialization compatibility with JDK 1.1. In JDK 1.2 and higher, the new
int
fieldmaximumIntegerDigits
is used instead. When writing to a stream,maxIntegerDigits
is set tomaximumIntegerDigits
orByte.MAX_VALUE
, whichever is smaller. When reading from a stream, this field is used only ifserialVersionOnStream
is less than 1.- See Also:
getMaximumIntegerDigits()
-
minIntegerDigits
private byte minIntegerDigits
The minimum number of digits allowed in the integer portion of a number.minimumIntegerDigits
must be less than or equal tomaximumIntegerDigits
.Note: This field exists only for serialization compatibility with JDK 1.1. In JDK 1.2 and higher, the new
int
fieldminimumIntegerDigits
is used instead. When writing to a stream,minIntegerDigits
is set tominimumIntegerDigits
orByte.MAX_VALUE
, whichever is smaller. When reading from a stream, this field is used only ifserialVersionOnStream
is less than 1.- See Also:
getMinimumIntegerDigits()
-
maxFractionDigits
private byte maxFractionDigits
The maximum number of digits allowed in the fractional portion of a number.maximumFractionDigits
must be greater than or equal tominimumFractionDigits
.Note: This field exists only for serialization compatibility with JDK 1.1. In JDK 1.2 and higher, the new
int
fieldmaximumFractionDigits
is used instead. When writing to a stream,maxFractionDigits
is set tomaximumFractionDigits
orByte.MAX_VALUE
, whichever is smaller. When reading from a stream, this field is used only ifserialVersionOnStream
is less than 1.- See Also:
getMaximumFractionDigits()
-
minFractionDigits
private byte minFractionDigits
The minimum number of digits allowed in the fractional portion of a number.minimumFractionDigits
must be less than or equal tomaximumFractionDigits
.Note: This field exists only for serialization compatibility with JDK 1.1. In JDK 1.2 and higher, the new
int
fieldminimumFractionDigits
is used instead. When writing to a stream,minFractionDigits
is set tominimumFractionDigits
orByte.MAX_VALUE
, whichever is smaller. When reading from a stream, this field is used only ifserialVersionOnStream
is less than 1.- See Also:
getMinimumFractionDigits()
-
parseIntegerOnly
private boolean parseIntegerOnly
True if this format will parse numbers as integers only.- See Also:
isParseIntegerOnly()
-
maximumIntegerDigits
private int maximumIntegerDigits
The maximum number of digits allowed in the integer portion of a number.maximumIntegerDigits
must be greater than or equal tominimumIntegerDigits
.- See Also:
getMaximumIntegerDigits()
-
minimumIntegerDigits
private int minimumIntegerDigits
The minimum number of digits allowed in the integer portion of a number.minimumIntegerDigits
must be less than or equal tomaximumIntegerDigits
.- See Also:
getMinimumIntegerDigits()
-
maximumFractionDigits
private int maximumFractionDigits
The maximum number of digits allowed in the fractional portion of a number.maximumFractionDigits
must be greater than or equal tominimumFractionDigits
.- See Also:
getMaximumFractionDigits()
-
minimumFractionDigits
private int minimumFractionDigits
The minimum number of digits allowed in the fractional portion of a number.minimumFractionDigits
must be less than or equal tomaximumFractionDigits
.- See Also:
getMinimumFractionDigits()
-
currency
private Currency currency
Currency object used to format currencies. Subclasses may ignore this if they are not currency formats. This will be null unless a subclass sets it to a non-null value.- Since:
- ICU 2.6
-
currentSerialVersion
static final int currentSerialVersion
- See Also:
- Constant Field Values
-
serialVersionOnStream
private int serialVersionOnStream
Describes the version ofNumberFormat
present on the stream. Possible values are:- 0 (or uninitialized): the JDK 1.1 version of the stream format.
In this version, the
int
fields such asmaximumIntegerDigits
were not present, and thebyte
fields such asmaxIntegerDigits
are used instead. - 1: the JDK 1.2 version of the stream format. The values of the
byte
fields such asmaxIntegerDigits
are ignored, and theint
fields such asmaximumIntegerDigits
are used instead. - 2: adds capitalizationSetting.
NumberFormat
, the most recent format (corresponding to the highest allowableserialVersionOnStream
) is always written. - 0 (or uninitialized): the JDK 1.1 version of the stream format.
In this version, the
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
parseStrict
private boolean parseStrict
-
capitalizationSetting
private DisplayContext capitalizationSetting
-
-
Method Detail
-
format
public java.lang.StringBuffer format(java.lang.Object number, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
Formats a number and appends the resulting text to the given string buffer. recognizesBigInteger
andBigDecimal
objects.- Specified by:
format
in classjava.text.Format
- See Also:
Format.format(Object, StringBuffer, FieldPosition)
-
parseObject
public final java.lang.Object parseObject(java.lang.String source, java.text.ParsePosition parsePosition)
Parses text from a string to produce a number.- Specified by:
parseObject
in classjava.text.Format
- Parameters:
source
- the String to parseparsePosition
- the position at which to start the parse- Returns:
- the parsed number, or null
- See Also:
NumberFormat.parseObject(String, ParsePosition)
-
format
public final java.lang.String format(double number)
Specialization of format.- See Also:
Format.format(Object)
-
format
public final java.lang.String format(long number)
Specialization of format.- See Also:
Format.format(Object)
-
format
public final java.lang.String format(java.math.BigInteger number)
Convenience method to format a BigInteger.
-
format
public final java.lang.String format(java.math.BigDecimal number)
Convenience method to format a BigDecimal.
-
format
public final java.lang.String format(BigDecimal number)
Convenience method to format an ICU BigDecimal.
-
format
public final java.lang.String format(CurrencyAmount currAmt)
Convenience method to format a CurrencyAmount.
-
format
public abstract java.lang.StringBuffer format(double number, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
Specialization of format.- See Also:
Format.format(Object, StringBuffer, FieldPosition)
-
format
public abstract java.lang.StringBuffer format(long number, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
Specialization of format.- See Also:
Format.format(Object, StringBuffer, FieldPosition)
-
format
public abstract java.lang.StringBuffer format(java.math.BigInteger number, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
Formats a BigInteger. Specialization of format.- See Also:
Format.format(Object, StringBuffer, FieldPosition)
-
format
public abstract java.lang.StringBuffer format(java.math.BigDecimal number, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
Formats a BigDecimal. Specialization of format.- See Also:
Format.format(Object, StringBuffer, FieldPosition)
-
format
public abstract java.lang.StringBuffer format(BigDecimal number, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
Formats an ICU BigDecimal. Specialization of format.- See Also:
Format.format(Object, StringBuffer, FieldPosition)
-
format
public java.lang.StringBuffer format(CurrencyAmount currAmt, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
Formats a CurrencyAmount. Specialization of format.- See Also:
Format.format(Object, StringBuffer, FieldPosition)
-
parse
public abstract java.lang.Number parse(java.lang.String text, java.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. 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:
isParseIntegerOnly()
,DecimalFormat.setParseBigDecimal(boolean)
,Format.parseObject(String, ParsePosition)
-
parse
public java.lang.Number parse(java.lang.String text) throws java.text.ParseException
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:
java.text.ParseException
- if the beginning of the specified string cannot be parsed.- See Also:
format(java.lang.Object, java.lang.StringBuffer, java.text.FieldPosition)
-
parseCurrency
public CurrencyAmount parseCurrency(java.lang.CharSequence text, java.text.ParsePosition pos)
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:
isParseIntegerOnly()
-
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:
isParseStrict()
- 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:
setParseStrict(boolean)
-
setContext
public void setContext(DisplayContext context)
Set a particular DisplayContext value in the formatter, such as CAPITALIZATION_FOR_STANDALONE.- Parameters:
context
- The DisplayContext value to set.
-
getContext
public DisplayContext getContext(DisplayContext.Type type)
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
public static final NumberFormat 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:
ULocale.Category.FORMAT
-
getInstance
public static NumberFormat getInstance(java.util.Locale inLocale)
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
public static NumberFormat getInstance(ULocale inLocale)
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
public static final NumberFormat getInstance(int style)
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:
ULocale.Category.FORMAT
-
getInstance
public static NumberFormat getInstance(java.util.Locale inLocale, int style)
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
public static final NumberFormat 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:
ULocale.Category.FORMAT
-
getNumberInstance
public static NumberFormat getNumberInstance(java.util.Locale inLocale)
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns a general-purpose number format for the specified locale.
-
getNumberInstance
public static NumberFormat getNumberInstance(ULocale inLocale)
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns a general-purpose number format for the specified locale.
-
getIntegerInstance
public static final NumberFormat 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:
ULocale.Category.FORMAT
-
getIntegerInstance
public static NumberFormat getIntegerInstance(java.util.Locale inLocale)
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
public static NumberFormat getIntegerInstance(ULocale inLocale)
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
public static final NumberFormat 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:
ULocale.Category.FORMAT
-
getCurrencyInstance
public static NumberFormat getCurrencyInstance(java.util.Locale inLocale)
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
public static NumberFormat getCurrencyInstance(ULocale inLocale)
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
public static final NumberFormat 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:
ULocale.Category.FORMAT
-
getPercentInstance
public static NumberFormat getPercentInstance(java.util.Locale inLocale)
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
public static NumberFormat getPercentInstance(ULocale inLocale)
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
public static final NumberFormat 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:
ULocale.Category.FORMAT
-
getScientificInstance
public static NumberFormat getScientificInstance(java.util.Locale inLocale)
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
public static NumberFormat getScientificInstance(ULocale inLocale)
NOTE: New users are strongly encouraged to useNumberFormatter
instead of NumberFormat.
Returns a scientific format for the specified locale.- Returns:
- a scientific number format
-
getShim
private static NumberFormat.NumberFormatShim getShim()
-
getAvailableLocales
public static java.util.Locale[] getAvailableLocales()
Returns the list of Locales for which NumberFormats are available.- Returns:
- the available locales
-
getAvailableULocales
public static ULocale[] getAvailableULocales()
Returns the list of Locales for which NumberFormats are available.- Returns:
- the available locales
-
registerFactory
public static java.lang.Object registerFactory(NumberFormat.NumberFormatFactory factory)
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
public static boolean unregister(java.lang.Object registryKey)
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()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
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.- Overrides:
equals
in classjava.lang.Object
- Parameters:
obj
- the object to compare against- Returns:
- true if the object is equal to this.
-
clone
public java.lang.Object clone()
Overrides clone.- Overrides:
clone
in classjava.text.Format
-
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(boolean)
-
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:
isGroupingUsed()
-
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(int)
-
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:
getMaximumIntegerDigits()
-
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(int)
-
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:
getMinimumIntegerDigits()
-
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(int)
-
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:
getMaximumFractionDigits()
-
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(int)
-
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:
getMinimumFractionDigits()
-
setCurrency
public void setCurrency(Currency theCurrency)
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
public Currency getCurrency()
Returns the Currency object used to display currency amounts. This may be null.
-
getEffectiveCurrency
@Deprecated protected Currency 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(int)
-
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:
getRoundingMode()
-
getInstance
public static NumberFormat getInstance(ULocale desiredLocale, int choice)
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:
java.lang.IllegalArgumentException
- if choice is not one of NUMBERSTYLE, CURRENCYSTYLE, PERCENTSTYLE, SCIENTIFICSTYLE, INTEGERSTYLE, ISOCURRENCYSTYLE, PLURALCURRENCYSTYLE, ACCOUNTINGCURRENCYSTYLE. CASHCURRENCYSTYLE, STANDARDCURRENCYSTYLE.
-
createInstance
static NumberFormat createInstance(ULocale desiredLocale, int choice)
-
getPattern
@Deprecated protected static java.lang.String getPattern(java.util.Locale forLocale, int choice)
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
protected static java.lang.String getPattern(ULocale forLocale, int choice)
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 public static java.lang.String getPatternForStyle(ULocale forLocale, int choice)
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 java.lang.String getPatternForStyleAndNumberingSystem(ULocale forLocale, java.lang.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
-
readObject
private void readObject(java.io.ObjectInputStream stream) throws java.io.IOException, java.lang.ClassNotFoundException
First, read in the default serializable data. Then, ifserialVersionOnStream
is less than 1, indicating that the stream was written by JDK 1.1, set theint
fields such asmaximumIntegerDigits
to be equal to thebyte
fields such asmaxIntegerDigits
, since theint
fields were not present in JDK 1.1. Finally, set serialVersionOnStream back to the maximum allowed value so that default serialization will work properly if this object is streamed out again.- Throws:
java.io.IOException
java.lang.ClassNotFoundException
-
writeObject
private void writeObject(java.io.ObjectOutputStream stream) throws java.io.IOException
Write out the default serializable data, after first setting thebyte
fields such asmaxIntegerDigits
to be equal to theint
fields such asmaximumIntegerDigits
(or toByte.MAX_VALUE
, whichever is smaller), for compatibility with the JDK 1.1 version of the stream format.- Throws:
java.io.IOException
-
-