Added in API level 30

Precision

abstract class Precision
kotlin.Any
   ↳ android.icu.number.Precision

A class that defines the rounding precision to be used when formatting numbers in NumberFormatter.

To create a Precision, use one of the factory methods.

Summary

Public methods
open static CurrencyPrecision!

Show numbers rounded and padded according to the rules for the currency unit.
open static FractionPrecision!
fixedFraction(minMaxFractionPlaces: Int)

Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal separator).
open static Precision!
fixedSignificantDigits(minMaxSignificantDigits: Int)

Show numbers rounded if necessary to a certain number of significant digits or significant figures.
open static Precision!
increment(roundingIncrement: BigDecimal!)

Show numbers rounded if necessary to the closest multiple of a certain rounding increment.
open static FractionPrecision!

Show numbers rounded if necessary to the nearest integer.
open static FractionPrecision!
maxFraction(maxFractionPlaces: Int)

Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal separator).
open static Precision!
maxSignificantDigits(maxSignificantDigits: Int)

Show numbers rounded if necessary to a certain number of significant digits/figures.
open static FractionPrecision!
minFraction(minFractionPlaces: Int)

Always show at least a certain number of fraction places after the decimal separator, padding with zeros if necessary.
open static FractionPrecision!
minMaxFraction(minFractionPlaces: Int, maxFractionPlaces: Int)

Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal separator); in addition, always show at least a certain number of places after the decimal separator, padding with zeros if necessary.
open static Precision!
minMaxSignificantDigits(minSignificantDigits: Int, maxSignificantDigits: Int)

Show numbers rounded if necessary to a certain number of significant digits/figures; in addition, always show at least a certain number of significant digits, padding with zeros if necessary.
open static Precision!
minSignificantDigits(minSignificantDigits: Int)

Always show at least a certain number of significant digits/figures, padding with zeros if necessary.
open Precision!

Configure how trailing zeros are displayed on numbers.
open static Precision!

Show all available digits to full precision.

Public methods

currency

Added in API level 30
open static fun currency(currencyUsage: Currency.CurrencyUsage!): CurrencyPrecision!

Show numbers rounded and padded according to the rules for the currency unit. The most common rounding precision settings for currencies include Precision.fixedFraction(2), Precision.integer(), and Precision.increment(0.05) for cash transactions ("nickel rounding").

The exact rounding details will be resolved at runtime based on the currency unit specified in the NumberFormatter chain. To round according to the rules for one currency while displaying the symbol for another currency, the withCurrency() method can be called on the return value of this method.

Parameters
currencyUsage Currency.CurrencyUsage!: Either STANDARD (for digital transactions) or CASH (for transactions where the rounding increment may be limited by the available denominations of cash or coins).
Return
CurrencyPrecision! A CurrencyPrecision for chaining or passing to the NumberFormatter precision() setter.
Exceptions
java.lang.IllegalArgumentException if currencyUsage is null.

fixedFraction

Added in API level 30
open static fun fixedFraction(minMaxFractionPlaces: Int): FractionPrecision!

Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal separator). Additionally, pad with zeros to ensure that this number of places are always shown.

Example output with minMaxFractionPlaces = 3:

87,650.000
8,765.000
876.500
87.650
8.765
0.876
0.088
0.009
0.000 (zero)

This method is equivalent to minMaxFraction with both arguments equal.

Parameters
minMaxFractionPlaces Int: The minimum and maximum number of numerals to display after the decimal separator (rounding if too long or padding with zeros if too short).
Return
FractionPrecision! A FractionPrecision for chaining or passing to the NumberFormatter precision() setter.
Exceptions
java.lang.IllegalArgumentException if the input number is too big or smaller than 0.

fixedSignificantDigits

Added in API level 30
open static fun fixedSignificantDigits(minMaxSignificantDigits: Int): Precision!

Show numbers rounded if necessary to a certain number of significant digits or significant figures. Additionally, pad with zeros to ensure that this number of significant digits/figures are always shown.

This method is equivalent to minMaxSignificantDigits with both arguments equal.

Parameters
minMaxSignificantDigits Int: The minimum and maximum number of significant digits to display (rounding if too long or padding with zeros if too short).
Return
Precision! A Precision for chaining or passing to the NumberFormatter precision() setter.
Exceptions
java.lang.IllegalArgumentException if the input number is too big or smaller than 1.

increment

Added in API level 30
open static fun increment(roundingIncrement: BigDecimal!): Precision!

Show numbers rounded if necessary to the closest multiple of a certain rounding increment. For example, if the rounding increment is 0.5, then round 1.2 to 1 and round 1.3 to 1.5.

In order to ensure that numbers are padded to the appropriate number of fraction places, set the scale on the rounding increment BigDecimal. For example, to round to the nearest 0.5 and always display 2 numerals after the decimal separator (to display 1.2 as "1.00" and 1.3 as "1.50"), you can run: 

Precision.increment(new BigDecimal("0.50"))

For more information on the scale of Java BigDecimal, see java.math.BigDecimal#scale().

Parameters
roundingIncrement BigDecimal!: The increment to which to round numbers.
Return
Precision! A Precision for chaining or passing to the NumberFormatter precision() setter.
Exceptions
java.lang.IllegalArgumentException if the rounding increment is null or non-positive.

integer

Added in API level 30
open static fun integer(): FractionPrecision!

Show numbers rounded if necessary to the nearest integer.

Return
FractionPrecision! A FractionPrecision for chaining or passing to the NumberFormatter precision() setter.

maxFraction

Added in API level 30
open static fun maxFraction(maxFractionPlaces: Int): FractionPrecision!

Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal separator). Unlike the other fraction rounding strategies, this strategy does not pad zeros to the end of the number.

Parameters
maxFractionPlaces Int: The maximum number of numerals to display after the decimal mark (rounding if necessary).
Return
FractionPrecision! A FractionPrecision for chaining or passing to the NumberFormatter precision() setter.
Exceptions
java.lang.IllegalArgumentException if the input number is too big or smaller than 0.

maxSignificantDigits

Added in API level 30
open static fun maxSignificantDigits(maxSignificantDigits: Int): Precision!

Show numbers rounded if necessary to a certain number of significant digits/figures.

Parameters
maxSignificantDigits Int: The maximum number of significant digits to display (rounding if too long).
Return
Precision! A Precision for chaining or passing to the NumberFormatter precision() setter.
Exceptions
java.lang.IllegalArgumentException if the input number is too big or smaller than 1.

minFraction

Added in API level 30
open static fun minFraction(minFractionPlaces: Int): FractionPrecision!

Always show at least a certain number of fraction places after the decimal separator, padding with zeros if necessary. Do not perform rounding (display numbers to their full precision).

NOTE: If you are formatting doubles, see the performance note in unlimited.

Parameters
minFractionPlaces Int: The minimum number of numerals to display after the decimal separator (padding with zeros if necessary).
Return
FractionPrecision! A FractionPrecision for chaining or passing to the NumberFormatter precision() setter.
Exceptions
java.lang.IllegalArgumentException if the input number is too big or smaller than 0.

minMaxFraction

Added in API level 30
open static fun minMaxFraction(
    minFractionPlaces: Int, 
    maxFractionPlaces: Int
): FractionPrecision!

Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal separator); in addition, always show at least a certain number of places after the decimal separator, padding with zeros if necessary.

Parameters
minFractionPlaces Int: The minimum number of numerals to display after the decimal separator (padding with zeros if necessary).
maxFractionPlaces Int: The maximum number of numerals to display after the decimal separator (rounding if necessary).
Return
FractionPrecision! A FractionPrecision for chaining or passing to the NumberFormatter precision() setter.
Exceptions
java.lang.IllegalArgumentException if the input number is too big or smaller than 0.

minMaxSignificantDigits

Added in API level 30
open static fun minMaxSignificantDigits(
    minSignificantDigits: Int, 
    maxSignificantDigits: Int
): Precision!

Show numbers rounded if necessary to a certain number of significant digits/figures; in addition, always show at least a certain number of significant digits, padding with zeros if necessary.

Parameters
minSignificantDigits Int: The minimum number of significant digits to display (padding with zeros if necessary).
maxSignificantDigits Int: The maximum number of significant digits to display (rounding if necessary).
Return
Precision! A Precision for chaining or passing to the NumberFormatter precision() setter.
Exceptions
java.lang.IllegalArgumentException if the input number is too big or smaller than 1.

minSignificantDigits

Added in API level 30
open static fun minSignificantDigits(minSignificantDigits: Int): Precision!

Always show at least a certain number of significant digits/figures, padding with zeros if necessary. Do not perform rounding (display numbers to their full precision).

NOTE: If you are formatting doubles, see the performance note in unlimited.

Parameters
minSignificantDigits Int: The minimum number of significant digits to display (padding with zeros if too short).
Return
Precision! A Precision for chaining or passing to the NumberFormatter precision() setter.
Exceptions
java.lang.IllegalArgumentException if the input number is too big or smaller than 1.

trailingZeroDisplay

Added in API level 34
open fun trailingZeroDisplay(trailingZeroDisplay: NumberFormatter.TrailingZeroDisplay!): Precision!

Configure how trailing zeros are displayed on numbers. For example, to hide trailing zeros when the number is an integer, use HIDE_IF_WHOLE.

Parameters
trailingZeroDisplay NumberFormatter.TrailingZeroDisplay!: Option to configure the display of trailing zeros.

unlimited

Added in API level 30
open static fun unlimited(): Precision!

Show all available digits to full precision.

NOTE: When formatting a double, this method, along with minFraction and minSignificantDigits, will trigger complex algorithm similar to Dragon4 to determine the low-order digits and the number of digits to display based on the value of the double. If the number of fraction places or significant digits can be bounded, consider using maxFraction or maxSignificantDigits instead to maximize performance. For more information, read the following blog post.

http://www.serpentine.com/blog/2011/06/29/here-be-dragons-advances-in-problems-you-didnt-even-know-you-had/

Return
Precision! A Precision for chaining or passing to the NumberFormatter precision() setter.