com.ibm.icu.number

Class CurrencyPrecision

java.lang.Object

com.ibm.icu.number.Precision

com.ibm.icu.number.CurrencyPrecision

public abstract class CurrencyPrecision
extends Precision

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

Status:

Stable ICU 60.

Nested Class Summary

Nested classes/interfaces inherited from class com.ibm.icu.number.Precision

Precision.BogusRounder

Field Summary

Fields inherited from class com.ibm.icu.number.Precision

BOGUS_PRECISION

Method Summary

Modifier and Type	Method and Description
Precision	withCurrency(Currency currency) Associates a currency with this rounding strategy.

Methods inherited from class com.ibm.icu.number.Precision

apply, currency, fixedFraction, fixedSignificantDigits, increment, integer, maxFraction, maxSignificantDigits, minFraction, minMaxFraction, minMaxSignificantDigits, minSignificantDigits, trailingZeroDisplay, unlimited, withMode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withCurrency

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 - The currency to associate with this rounding strategy.

Returns:

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

Throws:

IllegalArgumentException - for null Currency

See Also:

NumberFormatter

Status:

Stable ICU 60.