NumberFormatter.SignDisplay


public static final enum NumberFormatter.SignDisplay
extends Enum<NumberFormatter.SignDisplay>

java.lang.Object
   ↳ java.lang.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.

See also:

Summary

Enum values

NumberFormatter.SignDisplay  ACCOUNTING

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

NumberFormatter.SignDisplay  ACCOUNTING_ALWAYS

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

NumberFormatter.SignDisplay  ACCOUNTING_EXCEPT_ZERO

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

NumberFormatter.SignDisplay  ACCOUNTING_NEGATIVE

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

NumberFormatter.SignDisplay  ALWAYS

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

NumberFormatter.SignDisplay  AUTO

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

NumberFormatter.SignDisplay  EXCEPT_ZERO

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

NumberFormatter.SignDisplay  NEGATIVE

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

NumberFormatter.SignDisplay  NEVER

Do not show the sign on positive or negative numbers. 

Public methods

static NumberFormatter.SignDisplay valueOf(String name)
static final SignDisplay[] values()

Inherited methods

Enum values

ACCOUNTING

Added in API level 30
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:

ACCOUNTING_ALWAYS

Added in API level 30
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:

ACCOUNTING_EXCEPT_ZERO

Added in API level 30
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:

ACCOUNTING_NEGATIVE

Added in API level 34
public static final NumberFormatter.SignDisplay ACCOUNTING_NEGATIVE

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

ALWAYS

Added in API level 30
public static final NumberFormatter.SignDisplay ALWAYS

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.

See also:

AUTO

Added in API level 30
public static final NumberFormatter.SignDisplay AUTO

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.

See also:

EXCEPT_ZERO

Added in API level 30
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:

NEGATIVE

Added in API level 34
public static final NumberFormatter.SignDisplay NEGATIVE

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

NEVER

Added in API level 30
public static final NumberFormatter.SignDisplay NEVER

Do not show the sign on positive or negative numbers.

See also:

Public methods

valueOf

public static NumberFormatter.SignDisplay valueOf (String name)

Parameters
name String

Returns
NumberFormatter.SignDisplay

values

public static final SignDisplay[] values ()

Returns
SignDisplay[]