Added in API level 30

Precision

public abstract class Precision
extends Object

java.lang.Object
   ↳ 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.

See also:

Summary

Public methods

static CurrencyPrecision currency(Currency.CurrencyUsage currencyUsage)

Show numbers rounded and padded according to the rules for the currency unit.

static FractionPrecision fixedFraction(int minMaxFractionPlaces)

Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal separator).

static Precision fixedSignificantDigits(int minMaxSignificantDigits)

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

static Precision increment(BigDecimal roundingIncrement)

Show numbers rounded if necessary to the closest multiple of a certain rounding increment.

static FractionPrecision integer()

Show numbers rounded if necessary to the nearest integer.

static FractionPrecision maxFraction(int maxFractionPlaces)

Show numbers rounded if necessary to a certain number of fraction places (numerals after the decimal separator).

static Precision maxSignificantDigits(int maxSignificantDigits)

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

static FractionPrecision minFraction(int minFractionPlaces)

Always show at least a certain number of fraction places after the decimal separator, padding with zeros if necessary.

static FractionPrecision minMaxFraction(int minFractionPlaces, int maxFractionPlaces)

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.

static Precision minMaxSignificantDigits(int minSignificantDigits, int maxSignificantDigits)

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.

static Precision minSignificantDigits(int minSignificantDigits)

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

Precision trailingZeroDisplay(NumberFormatter.TrailingZeroDisplay trailingZeroDisplay)

Configure how trailing zeros are displayed on numbers.

static Precision unlimited()

Show all available digits to full precision.

Inherited methods

Public methods

currency

Added in API level 30
public static CurrencyPrecision currency (Currency.CurrencyUsage currencyUsage)

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).

Returns
CurrencyPrecision A CurrencyPrecision for chaining or passing to the NumberFormatter precision() setter.

Throws
IllegalArgumentException if currencyUsage is null.

See also:

fixedFraction

Added in API level 30
public static FractionPrecision fixedFraction (int minMaxFractionPlaces)

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(int, int) 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).

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

Throws
IllegalArgumentException if the input number is too big or smaller than 0.

See also:

fixedSignificantDigits

Added in API level 30
public static Precision fixedSignificantDigits (int minMaxSignificantDigits)

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(int, int) 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).

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

Throws
IllegalArgumentException if the input number is too big or smaller than 1.

See also:

increment

Added in API level 30
public static Precision increment (BigDecimal roundingIncrement)

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 BigDecimal.scale().

Parameters
roundingIncrement BigDecimal: The increment to which to round numbers.

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

Throws
IllegalArgumentException if the rounding increment is null or non-positive.

See also:

integer

Added in API level 30
public static FractionPrecision integer ()

Show numbers rounded if necessary to the nearest integer.

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

See also:

maxFraction

Added in API level 30
public static FractionPrecision maxFraction (int maxFractionPlaces)

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).

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

Throws
IllegalArgumentException if the input number is too big or smaller than 0.

See also:

maxSignificantDigits

Added in API level 30
public static Precision maxSignificantDigits (int maxSignificantDigits)

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).

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

Throws
IllegalArgumentException if the input number is too big or smaller than 1.

See also:

minFraction

Added in API level 30
public static FractionPrecision minFraction (int minFractionPlaces)

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).

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

Throws
IllegalArgumentException if the input number is too big or smaller than 0.

See also:

minMaxFraction

Added in API level 30
public static FractionPrecision minMaxFraction (int minFractionPlaces, 
                int maxFractionPlaces)

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).

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

Throws
IllegalArgumentException if the input number is too big or smaller than 0.

See also:

minMaxSignificantDigits

Added in API level 30
public static Precision minMaxSignificantDigits (int minSignificantDigits, 
                int maxSignificantDigits)

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).

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

Throws
IllegalArgumentException if the input number is too big or smaller than 1.

See also:

minSignificantDigits

Added in API level 30
public static Precision minSignificantDigits (int minSignificantDigits)

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).

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

Throws
IllegalArgumentException if the input number is too big or smaller than 1.

See also:

trailingZeroDisplay

Added in API level 34
public Precision trailingZeroDisplay (NumberFormatter.TrailingZeroDisplay trailingZeroDisplay)

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.

Returns
Precision

unlimited

Added in API level 30
public static Precision unlimited ()

Show all available digits to full precision.

NOTE: When formatting a double, this method, along with minFraction(int) and minSignificantDigits(int), 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(int) or maxSignificantDigits(int) 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/

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

See also: