Added in API level 30

SignDisplay


class SignDisplay
kotlin.Any
   ↳ kotlin.Enum<android.icu.number.NumberFormatter.SignDisplay>
   ↳ android.icu.number.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.

Summary

Enum values

Use the locale-dependent accounting format on negative numbers, and do not show the sign on positive numbers.

Use the locale-dependent accounting format on negative numbers, and show the plus sign on positive numbers, including zero.

Use the locale-dependent accounting format on negative numbers, and show the plus sign on positive numbers.

Same as ACCOUNTING, but do not show the sign on negative zero.

Show the minus sign on negative numbers and the plus sign on positive numbers, including zero.

Show the minus sign on negative numbers, and do not show the sign on positive numbers.

Show the minus sign on negative numbers and the plus sign on positive numbers.

Same as AUTO, but do not show the sign on negative zero.

Do not show the sign on positive or negative numbers.

Enum values

ACCOUNTING

Added in API level 30
enum val ACCOUNTING : NumberFormatter.SignDisplay

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.

ACCOUNTING_ALWAYS

Added in API level 30
enum val ACCOUNTING_ALWAYS : NumberFormatter.SignDisplay

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.

ACCOUNTING_EXCEPT_ZERO

Added in API level 30
enum val ACCOUNTING_EXCEPT_ZERO : NumberFormatter.SignDisplay

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.

ACCOUNTING_NEGATIVE

Added in API level 34
enum val ACCOUNTING_NEGATIVE : NumberFormatter.SignDisplay

Same as ACCOUNTING, but do not show the sign on negative zero.

ALWAYS

Added in API level 30
enum val ALWAYS : NumberFormatter.SignDisplay

Show the minus sign on negative numbers and the plus sign on positive numbers, including zero. To hide the sign on zero, see EXCEPT_ZERO.

AUTO

Added in API level 30
enum val AUTO : NumberFormatter.SignDisplay

Show the minus sign on negative numbers, and do not show the sign on positive numbers. This is the default behavior. If using this option, a sign will be displayed on negative zero, including negative numbers that round to zero. To hide the sign on negative zero, use the NEGATIVE option.

EXCEPT_ZERO

Added in API level 30
enum val EXCEPT_ZERO : NumberFormatter.SignDisplay

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.

NEGATIVE

Added in API level 34
enum val NEGATIVE : NumberFormatter.SignDisplay

Same as AUTO, but do not show the sign on negative zero.

NEVER

Added in API level 30
enum val NEVER : NumberFormatter.SignDisplay

Do not show the sign on positive or negative numbers.