Class CurrencyPrecision

  • Direct Known Subclasses:
    Precision.CurrencyRounderImpl

    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
    • Constructor Detail

      • CurrencyPrecision

        CurrencyPrecision()
    • 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:
        java.lang.IllegalArgumentException - for null Currency
        See Also:
        NumberFormatter