Enum NumberFormatter.SignDisplay

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<NumberFormatter.SignDisplay>
    Enclosing class:
    NumberFormatter

    public static enum NumberFormatter.SignDisplay
    extends java.lang.Enum<NumberFormatter.SignDisplay>
    An enum declaring how to denote positive and negative numbers. Example outputs when formatting 123, 0, and -123 in en-US:
    • AUTO: "123", "0", and "-123"
    • ALWAYS: "+123", "+0", and "-123"
    • NEVER: "123", "0", and "123"
    • ACCOUNTING: "$123", "$0", and "($123)"
    • ACCOUNTING_ALWAYS: "+$123", "+$0", and "($123)"
    • EXCEPT_ZERO: "+123", "0", and "-123"
    • ACCOUNTING_EXCEPT_ZERO: "+$123", "$0", and "($123)"

    The exact format, including the position and the code point of the sign, differ by locale.

    See Also:
    NumberFormatter
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ACCOUNTING
      Use the locale-dependent accounting format on negative numbers, and do not show the sign on positive numbers.
      ACCOUNTING_ALWAYS
      Use the locale-dependent accounting format on negative numbers, and show the plus sign on positive numbers, including zero.
      ACCOUNTING_EXCEPT_ZERO
      Use the locale-dependent accounting format on negative numbers, and show the plus sign on positive numbers.
      ALWAYS
      Show the minus sign on negative numbers and the plus sign on positive numbers, including zero.
      AUTO
      Show the minus sign on negative numbers, and do not show the sign on positive numbers.
      EXCEPT_ZERO
      Show the minus sign on negative numbers and the plus sign on positive numbers.
      NEVER
      Do not show the sign on positive or negative numbers.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static NumberFormatter.SignDisplay valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static NumberFormatter.SignDisplay[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • ACCOUNTING

        public static final NumberFormatter.SignDisplay ACCOUNTING
        Use the locale-dependent accounting format on negative numbers, and do not show the sign on positive numbers.

        The accounting format is defined in CLDR and varies by locale; in many Western locales, the format is a pair of parentheses around the number.

        Note: Since CLDR defines the accounting format in the monetary context only, this option falls back to the AUTO sign display strategy when formatting without a currency unit. This limitation may be lifted in the future.

        See Also:
        NumberFormatter
      • ACCOUNTING_ALWAYS

        public static final NumberFormatter.SignDisplay ACCOUNTING_ALWAYS
        Use the locale-dependent accounting format on negative numbers, and show the plus sign on positive numbers, including zero. For more information on the accounting format, see the ACCOUNTING sign display strategy. To hide the sign on zero, see ACCOUNTING_EXCEPT_ZERO.
        See Also:
        NumberFormatter
      • EXCEPT_ZERO

        public static final NumberFormatter.SignDisplay EXCEPT_ZERO
        Show the minus sign on negative numbers and the plus sign on positive numbers. Do not show a sign on zero, numbers that round to zero, or NaN.
        See Also:
        NumberFormatter
      • ACCOUNTING_EXCEPT_ZERO

        public static final NumberFormatter.SignDisplay ACCOUNTING_EXCEPT_ZERO
        Use the locale-dependent accounting format on negative numbers, and show the plus sign on positive numbers. Do not show a sign on zero, numbers that round to zero, or NaN. For more information on the accounting format, see the ACCOUNTING sign display strategy.
        See Also:
        NumberFormatter
    • Method Detail

      • values

        public static NumberFormatter.SignDisplay[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (NumberFormatter.SignDisplay c : NumberFormatter.SignDisplay.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static NumberFormatter.SignDisplay valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null