Most visited

Recently visited

Results for

Added in API level 24

NumberFormat

public abstract class NumberFormat
extends UFormat

java.lang.Object
↳	java.text.Format
	↳	android.icu.text.UFormat
		↳	android.icu.text.NumberFormat

Known Direct Subclasses

DecimalFormat

Known Indirect Subclasses

CompactDecimalFormat

[icu enhancement] ICU's replacement for NumberFormat. Methods, fields, and other functionality specific to ICU are labeled '[icu]'. 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);

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.

 NumberFormat nf = NumberFormat.getInstance();
 for (int i = 0; i < a.length; ++i) {
     output.println(nf.format(myNumber[i]) + "; ");
 }

To format a number for a different Locale, specify it in the call to getInstance.

 NumberFormat nf = NumberFormat.getInstance(Locale.FRENCH);

You can also use a NumberFormat to parse numbers:

 myNumber = nf.parse(myString);

Use 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

For example, you can align numbers in two ways:

If you are using a monospaced font with spacing for alignment, you can pass the FieldPosition in your format call, with field = 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

Summary

Nested classes
`class`	`NumberFormat.Field` The instances of this inner class are used as attribute keys and values in AttributedCharacterIterator that NumberFormat.formatToCharacterIterator() method returns.

Constants
`int`	`ACCOUNTINGCURRENCYSTYLE` [icu] 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`).
`int`	`CASHCURRENCYSTYLE` [icu] 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".
`int`	`CURRENCYSTYLE` [icu] Constant to specify general currency style of format.
`int`	`FRACTION_FIELD` Field constant used to construct a FieldPosition object.
`int`	`INTEGERSTYLE` [icu] Constant to specify a integer number style format.
`int`	`INTEGER_FIELD` Field constant used to construct a FieldPosition object.
`int`	`ISOCURRENCYSTYLE` [icu] Constant to specify currency style of format which uses currency ISO code to represent currency, for example: "USD3.00".
`int`	`NUMBERSTYLE` [icu] Constant to specify normal number style of format.
`int`	`PERCENTSTYLE` [icu] Constant to specify a style of format to display percent.
`int`	`PLURALCURRENCYSTYLE` [icu] Constant to specify currency style of format which uses currency long name with plural format to represent currency, for example, "3.00 US Dollars".
`int`	`SCIENTIFICSTYLE` [icu] Constant to specify a style of format to display scientific number.

Public constructors
`NumberFormat()` Empty constructor.

Public methods
`Object`	`clone()` Overrides clone.
`boolean`	`equals(Object obj)` Overrides equals.
`abstract StringBuffer`	`format(BigInteger number, StringBuffer toAppendTo, FieldPosition pos)` [icu] Formats a BigInteger.
`abstract StringBuffer`	`format(BigDecimal number, StringBuffer toAppendTo, FieldPosition pos)` [icu] Formats an ICU BigDecimal.
`StringBuffer`	`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(double number, StringBuffer toAppendTo, FieldPosition pos)` Specialization of format.
`final String`	`format(BigInteger number)` [icu] Convenience method to format a BigInteger.
`abstract StringBuffer`	`format(BigDecimal number, StringBuffer toAppendTo, FieldPosition pos)` [icu] Formats a BigDecimal.
`final String`	`format(BigDecimal number)` [icu] Convenience method to format an ICU BigDecimal.
`final String`	`format(double number)` Specialization of format.
`final String`	`format(long number)` Specialization of format.
`StringBuffer`	`format(CurrencyAmount currAmt, StringBuffer toAppendTo, FieldPosition pos)` [icu] Formats a CurrencyAmount.
`final String`	`format(CurrencyAmount currAmt)` [icu] Convenience method to format a CurrencyAmount.
`abstract StringBuffer`	`format(long number, StringBuffer toAppendTo, FieldPosition pos)` Specialization of format.
`static Locale[]`	`getAvailableLocales()` Returns the list of Locales for which NumberFormats are available.
`DisplayContext`	`getContext(DisplayContext.Type type)` [icu] 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(Locale inLocale)` Returns a currency format for the specified locale.
`static NumberFormat`	`getCurrencyInstance(ULocale inLocale)` [icu] Returns a currency format for the specified locale.
`static final NumberFormat`	`getCurrencyInstance()` Returns a currency format for the current default `FORMAT` locale.
`static final NumberFormat`	`getInstance()` Returns the default number format for the current default `FORMAT` locale.
`static NumberFormat`	`getInstance(Locale inLocale)` Returns the default number format for the specified locale.
`static NumberFormat`	`getInstance(ULocale desiredLocale, int choice)` Returns a specific style number format for a specific locale.
`static NumberFormat`	`getInstance(Locale inLocale, int style)` [icu] Returns a specific style number format for a specific locale.
`static NumberFormat`	`getInstance(ULocale inLocale)` [icu] Returns the default number format for the specified locale.
`static final NumberFormat`	`getInstance(int style)` [icu] Returns a specific style number format for default `FORMAT` locale.
`static NumberFormat`	`getIntegerInstance(ULocale inLocale)` [icu] Returns an integer number format for the specified locale.
`static final NumberFormat`	`getIntegerInstance()` Returns an integer number format for the current default `FORMAT` locale.
`static NumberFormat`	`getIntegerInstance(Locale inLocale)` 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 NumberFormat`	`getNumberInstance(ULocale inLocale)` [icu] Returns a general-purpose number format for the specified locale.
`static final NumberFormat`	`getNumberInstance()` Returns a general-purpose number format for the current default `FORMAT` locale.
`static NumberFormat`	`getNumberInstance(Locale inLocale)` 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(Locale inLocale)` Returns a percentage format for the specified locale.
`static NumberFormat`	`getPercentInstance(ULocale inLocale)` [icu] Returns a percentage format for the specified locale.
`int`	`getRoundingMode()` Returns the rounding mode used in this NumberFormat.
`static NumberFormat`	`getScientificInstance(ULocale inLocale)` [icu] Returns a scientific format for the specified locale.
`static NumberFormat`	`getScientificInstance(Locale inLocale)` [icu] Returns a scientific format for the specified locale.
`static final NumberFormat`	`getScientificInstance()` [icu] Returns a scientific format for the current default `FORMAT` locale.
`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.
`boolean`	`isParseStrict()` [icu] Returns whether strict parsing is in effect.
`Number`	`parse(String text)` 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 a Double.
`CurrencyAmount`	`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.
`void`	`setContext(DisplayContext context)` [icu] 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 or not numbers should be parsed as integers only.
`void`	`setParseStrict(boolean value)` [icu] Sets whether strict parsing is in effect.
`void`	`setRoundingMode(int roundingMode)` Set the rounding mode used in this NumberFormat.

Protected methods
`static String`	`getPattern(ULocale forLocale, int choice)` Returns the pattern for the provided locale and choice.

Inherited methods

From class


  
    java.text.Format

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Constants

ACCOUNTINGCURRENCYSTYLE

Added in API level 24

int ACCOUNTINGCURRENCYSTYLE

[icu] 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.

Constant Value: 7 (0x00000007)

CASHCURRENCYSTYLE

Added in API level 24

int CASHCURRENCYSTYLE

[icu] 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".

Constant Value: 8 (0x00000008)

CURRENCYSTYLE

Added in API level 24

int CURRENCYSTYLE

[icu] 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.

Constant Value: 1 (0x00000001)

FRACTION_FIELD

Added in API level 24

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 Value: 1 (0x00000001)

INTEGERSTYLE

Added in API level 24

int INTEGERSTYLE

[icu] Constant to specify a integer number style format.

Constant Value: 4 (0x00000004)

INTEGER_FIELD

Added in API level 24

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 Value: 0 (0x00000000)

ISOCURRENCYSTYLE

Added in API level 24

int ISOCURRENCYSTYLE

[icu] Constant to specify currency style of format which uses currency ISO code to represent currency, for example: "USD3.00".

Constant Value: 5 (0x00000005)

NUMBERSTYLE

Added in API level 24

int NUMBERSTYLE

[icu] Constant to specify normal number style of format.

Constant Value: 0 (0x00000000)

PERCENTSTYLE

Added in API level 24

int PERCENTSTYLE

[icu] Constant to specify a style of format to display percent.

Constant Value: 2 (0x00000002)

PLURALCURRENCYSTYLE

Added in API level 24

int PLURALCURRENCYSTYLE

[icu] Constant to specify currency style of format which uses currency long name with plural format to represent currency, for example, "3.00 US Dollars".

Constant Value: 6 (0x00000006)

SCIENTIFICSTYLE

Added in API level 24

int SCIENTIFICSTYLE

[icu] Constant to specify a style of format to display scientific number.

Constant Value: 3 (0x00000003)

Parameters
`number`	`BigInteger`
`toAppendTo`	`StringBuffer`
`pos`	`FieldPosition`

Parameters
`number`	`BigDecimal`
`toAppendTo`	`StringBuffer`
`pos`	`FieldPosition`

Parameters
`number`	`Object`: The object to format
`toAppendTo`	`StringBuffer`: where the text is to be appended
`pos`	`FieldPosition`: A `FieldPosition` identifying a field in the formatted text

Parameters
`number`	`double`
`toAppendTo`	`StringBuffer`
`pos`	`FieldPosition`

Parameters
`currAmt`	`CurrencyAmount`
`toAppendTo`	`StringBuffer`
`pos`	`FieldPosition`

Parameters
`number`	`long`
`toAppendTo`	`StringBuffer`
`pos`	`FieldPosition`

Parameters
`desiredLocale`	`ULocale`: the specific locale.
`choice`	`int`: number format style

Parameters
`inLocale`	`Locale`: the specific locale.
`style`	`int`: number format style

Parameters
`text`	`CharSequence`: the text to parse
`pos`	`ParsePosition`: 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.

Parameters
`source`	`String`: the String to parse
`parsePosition`	`ParsePosition`: the position at which to start the parse

Parameters
`forLocale`	`ULocale`: the locale of the data.
`choice`	`int`: the pattern format.

Most visited

Recently visited

Results for

NumberFormat

Synchronization

DecimalFormat

Summary

Nested classes

Constants

Public constructors

Public methods

Protected methods

Inherited methods

Constants

ACCOUNTINGCURRENCYSTYLE

CASHCURRENCYSTYLE

CURRENCYSTYLE

FRACTION_FIELD

INTEGERSTYLE

INTEGER_FIELD

ISOCURRENCYSTYLE

NUMBERSTYLE

PERCENTSTYLE

PLURALCURRENCYSTYLE

SCIENTIFICSTYLE

Public constructors

NumberFormat

Public methods

clone

equals

format

format

format

format

format

format

format

format

format

format

format

format

format

getAvailableLocales

getContext

getCurrency

getCurrencyInstance

getCurrencyInstance

getCurrencyInstance

getInstance

getInstance

getInstance

getInstance

getInstance

getInstance

getIntegerInstance

getIntegerInstance

getIntegerInstance

getMaximumFractionDigits

getMaximumIntegerDigits

getMinimumFractionDigits

getMinimumIntegerDigits

getNumberInstance

getNumberInstance

getNumberInstance

getPercentInstance

getPercentInstance

getPercentInstance

getRoundingMode

getScientificInstance

getScientificInstance

getScientificInstance

hashCode

isGroupingUsed

isParseIntegerOnly

isParseStrict

parse

parse

parseCurrency

parseObject