Class FractionPrecision


  • public abstract class FractionPrecision
    extends Precision
    A class that defines a rounding strategy based on a number of fraction places and optionally significant digits to be used when formatting numbers in NumberFormatter.

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

    See Also:
    NumberFormatter
    • Method Detail

      • withMinDigits

        public Precision withMinDigits​(int minSignificantDigits)
        Ensure that no less than this number of significant digits are retained when rounding according to fraction rules.

        For example, with integer rounding, the number 3.141 becomes "3". However, with minimum figures set to 2, 3.141 becomes "3.1" instead.

        This setting does not affect the number of trailing zeros. For example, 3.01 would print as "3", not "3.0".

        Parameters:
        minSignificantDigits - The number of significant figures to guarantee.
        Returns:
        A Precision for chaining or passing to the NumberFormatter rounding() setter.
        Throws:
        java.lang.IllegalArgumentException - if the input number is too big or smaller than 1.
        See Also:
        NumberFormatter
      • withMaxDigits

        public Precision withMaxDigits​(int maxSignificantDigits)
        Ensure that no more than this number of significant digits are retained when rounding according to fraction rules.

        For example, with integer rounding, the number 123.4 becomes "123". However, with maximum figures set to 2, 123.4 becomes "120" instead.

        This setting does not affect the number of trailing zeros. For example, with fixed fraction of 2, 123.4 would become "120.00".

        Parameters:
        maxSignificantDigits - Round the number to no more than this number of significant figures.
        Returns:
        A Precision for chaining or passing to the NumberFormatter rounding() setter.
        Throws:
        java.lang.IllegalArgumentException - if the input number is too big or smaller than 1.
        See Also:
        NumberFormatter