Most visited

Recently visited

Results for

Added in API level 24

Summary: Nested Classes | Inherited Constants | Methods | Inherited Methods | [Expand All]

CompactDecimalFormat

public class CompactDecimalFormat
extends DecimalFormat

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

The CompactDecimalFormat produces abbreviated numbers, suitable for display in environments will limited real estate. For example, 'Hits: 1.2B' instead of 'Hits: 1,200,000,000'. The format will be appropriate for the given language, such as "1,2 Mrd." for German.

For numbers under 1000 trillion (under 10^15, such as 123,456,789,012,345), the result will be short for supported languages. However, the result may sometimes exceed 7 characters, such as when there are combining marks or thin characters. In such cases, the visual width in fonts should still be short.

By default, there are 2 significant digits. After creation, if more than three significant digits are set (with setMaximumSignificantDigits), or if a fixed number of digits are set (with setMaximumIntegerDigits or setMaximumFractionDigits), then result may be wider.

At this time, negative numbers and parsing are not supported, and will produce an UnsupportedOperationException. Resetting the pattern prefixes or suffixes is not supported; the method calls are ignored.

Note that important methods, like setting the number of decimals, will be moved up from DecimalFormat to NumberFormat.

Summary

Nested classes
`enum`	`CompactDecimalFormat.CompactStyle` Style parameter for CompactDecimalFormat.

Inherited constants

From class


    android.icu.text.DecimalFormat

From class


    android.icu.text.NumberFormat

`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 methods
`boolean`	`equals(Object obj)` Overrides equals.
`StringBuffer`	`format(BigDecimal number, StringBuffer toAppendTo, FieldPosition pos)` Formats a BigDecimal number.
`StringBuffer`	`format(BigInteger number, StringBuffer toAppendTo, FieldPosition pos)` Formats a BigInteger number.
`StringBuffer`	`format(double number, StringBuffer toAppendTo, FieldPosition pos)` Specialization of format.
`StringBuffer`	`format(long number, StringBuffer toAppendTo, FieldPosition pos)` Specialization of format.
`StringBuffer`	`format(BigDecimal number, StringBuffer toAppendTo, FieldPosition pos)` Formats a BigDecimal number.
`AttributedCharacterIterator`	`formatToCharacterIterator(Object obj)` Formats the object to an attributed string, and return the corresponding iterator.
`static CompactDecimalFormat`	`getInstance(ULocale locale, CompactDecimalFormat.CompactStyle style)` Create a CompactDecimalFormat appropriate for a locale.
`static CompactDecimalFormat`	`getInstance(Locale locale, CompactDecimalFormat.CompactStyle style)` Create a CompactDecimalFormat appropriate for a locale.
`Number`	`parse(String text, ParsePosition parsePosition)` Parsing is currently unsupported, and throws an UnsupportedOperationException.

Inherited methods

From class


  
    android.icu.text.DecimalFormat

From class


  
    android.icu.text.NumberFormat

`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 String`	`getPattern(ULocale forLocale, int choice)` Returns the pattern for the provided locale and choice.
`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.

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.

Public methods

equals

Added in API level 24

boolean equals (Object obj)

Overrides equals.

Parameters
`obj`	`Object`: the object to compare against

Returns
`boolean`	true if the object is equal to this.

format

Added in API level 24

StringBuffer format (BigDecimal number, 
                StringBuffer toAppendTo, 
                FieldPosition pos)

Formats a BigDecimal number.

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

Returns
`StringBuffer`

format

Added in API level 24

StringBuffer format (BigInteger number, 
                StringBuffer toAppendTo, 
                FieldPosition pos)

Formats a BigInteger number.

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

Returns
`StringBuffer`

format

Added in API level 24

StringBuffer format (double number, 
                StringBuffer toAppendTo, 
                FieldPosition pos)

Specialization of format.

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

Returns
`StringBuffer`

format

Added in API level 24

StringBuffer format (long number, 
                StringBuffer toAppendTo, 
                FieldPosition pos)

Specialization of format.

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

Returns
`StringBuffer`

format

Added in API level 24

StringBuffer format (BigDecimal number, 
                StringBuffer toAppendTo, 
                FieldPosition pos)

Formats a BigDecimal number.

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

Returns
`StringBuffer`

formatToCharacterIterator

Added in API level 24

AttributedCharacterIterator formatToCharacterIterator (Object obj)

Formats the object to an attributed string, and return the corresponding iterator.

Parameters
`obj`	`Object`: The object to format

Returns
`AttributedCharacterIterator`	AttributedCharacterIterator describing the formatted value.

getInstance

Added in API level 24

CompactDecimalFormat getInstance (ULocale locale, 
                CompactDecimalFormat.CompactStyle style)

Create a CompactDecimalFormat appropriate for a locale. The result may be affected by the number system in the locale, such as ar-u-nu-latn.

Parameters
`locale`	`ULocale`: the desired locale
`style`	`CompactDecimalFormat.CompactStyle`: the compact style

Returns
`CompactDecimalFormat`

getInstance

Added in API level 24

CompactDecimalFormat getInstance (Locale locale, 
                CompactDecimalFormat.CompactStyle style)

Create a CompactDecimalFormat appropriate for a locale. The result may be affected by the number system in the locale, such as ar-u-nu-latn.

Parameters
`locale`	`Locale`: the desired locale
`style`	`CompactDecimalFormat.CompactStyle`: the compact style

Returns
`CompactDecimalFormat`

parse

Added in API level 24

Number parse (String text, 
                ParsePosition parsePosition)

Parsing is currently unsupported, and throws an UnsupportedOperationException.

Parameters
`text`	`String`: the string to be parsed
`parsePosition`	`ParsePosition`: defines the position where parsing is to begin, and upon return, the position where parsing left off. If the position has not changed upon return, then parsing failed.

Returns
`Number`	a `Number` object with the parsed value or `null` if the parse failed

Interfaces

Classes

Enums

Exceptions

Most visited

Recently visited

Results for

CompactDecimalFormat

Summary

Nested classes

Inherited constants

Public methods

Inherited methods

Public methods

equals

format

format

format

format

format

formatToCharacterIterator

getInstance

getInstance

parse