Added in API level 30

Summary: Enums | Methods | Inherited Methods

NumberFormatter.SignDisplay

Kotlin |Java

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:

NumberFormatter

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

From class


        
          java.lang.Enum

`final Object`	`clone()` Throws CloneNotSupportedException.
`final int`	`compareTo(NumberFormatter.SignDisplay o)` Compares this enum with the specified object for order.
`final boolean`	`equals(Object other)` Returns true if the specified object is equal to this enum constant.
`final void`	`finalize()` enum classes cannot have finalize methods.
`final Class<NumberFormatter.SignDisplay>`	`getDeclaringClass()` Returns the Class object corresponding to this enum constant's enum type.
`final int`	`hashCode()` Returns a hash code for this enum constant.
`final String`	`name()` Returns the name of this enum constant, exactly as declared in its enum declaration.
`final int`	`ordinal()` Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
`String`	`toString()` Returns the name of this enum constant, as contained in the declaration.
`static <T extends Enum<T>> T`	`valueOf(Class<T> enumClass, String name)` Returns the enum constant of the specified enum class with the specified name.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.lang.Comparable


      compareTo(NumberFormatter.SignDisplay o)

Compares this object with the specified object for order.

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:

NumberFormatter

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:

NumberFormatter

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:

NumberFormatter

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:

NumberFormatter

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:

NumberFormatter

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:

NumberFormatter

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:

NumberFormatter

Public methods

valueOf

public static NumberFormatter.SignDisplay valueOf (String name)

Parameters
`name`	`String`

Returns
`NumberFormatter.SignDisplay`

values

public static final SignDisplay[] values ()

Returns
`SignDisplay[]`