CurrencyPrecision

Kotlin |Java

public abstract class CurrencyPrecision
extends Precision

java.lang.Object
↳	android.icu.number.Precision
	↳	android.icu.number.CurrencyPrecision

A class that defines a rounding strategy parameterized by a currency to be used when formatting numbers in NumberFormatter.

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

See also:

NumberFormatter

Summary

Public methods
`Precision`	`withCurrency(Currency currency)` Associates a currency with this rounding strategy.

Inherited methods

From class


        
          android.icu.number.Precision

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

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 timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

withCurrency

Added in API level 30

public Precision withCurrency (Currency currency)

Associates a currency with this rounding strategy.

Calling this method is not required, because the currency specified in unit() or via a CurrencyAmount passed into format(Measure) is automatically applied to currency rounding strategies. However, this method enables you to override that automatic association.

This method also enables numbers to be formatted using currency rounding rules without explicitly using a currency format.

Parameters
`currency`	`Currency`: The currency to associate with this rounding strategy.

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

Throws
`IllegalArgumentException`	for null Currency

See also:

NumberFormatter