Added in API level 30

Summary: Enums | Methods | Inherited Methods

NumberFormatter.GroupingStrategy

Kotlin |Java

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

java.lang.Object
↳	java.lang.Enum<android.icu.number.NumberFormatter.GroupingStrategy>
	↳	android.icu.number.NumberFormatter.GroupingStrategy

An enum declaring the strategy for when and how to display grouping separators (i.e., the separator, often a comma or period, after every 2-3 powers of ten). The choices are several pre-built strategies for different use cases that employ locale data whenever possible. Example outputs for 1234 and 1234567 in en-IN:

OFF: 1234 and 12345
MIN2: 1234 and 12,34,567
AUTO: 1,234 and 12,34,567
ON_ALIGNED: 1,234 and 12,34,567
THOUSANDS: 1,234 and 1,234,567

The default is AUTO, which displays grouping separators unless the locale data says that grouping is not customary. To force grouping for all numbers greater than 1000 consistently across locales, use ON_ALIGNED. On the other hand, to display grouping less frequently than the default, use MIN2 or OFF. See the docs of each option for details.

Note: This enum specifies the strategy for grouping sizes. To set which character to use as the grouping separator, use the "symbols" setter.

See also:

NumberFormatter

Summary

Enum values
`NumberFormatter.GroupingStrategy`	`AUTO` Display grouping using the default strategy for all locales.
`NumberFormatter.GroupingStrategy`	`MIN2` Display grouping using locale defaults, except do not show grouping on values smaller than 10000 (such that there is a minimum of two digits before the first separator).
`NumberFormatter.GroupingStrategy`	`OFF` Do not display grouping separators in any locale.
`NumberFormatter.GroupingStrategy`	`ON_ALIGNED` Always display the grouping separator on values of at least 1000.
`NumberFormatter.GroupingStrategy`	`THOUSANDS` Use the Western defaults: groups of 3 and enabled for all numbers 1000 or greater.

Public methods
`static NumberFormatter.GroupingStrategy`	`valueOf(String name)`
`static final GroupingStrategy[]`	`values()`

Inherited methods

From class


        
          java.lang.Enum

`final Object`	`clone()` Throws CloneNotSupportedException.
`final int`	`compareTo(NumberFormatter.GroupingStrategy 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.GroupingStrategy>`	`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.GroupingStrategy o)

Compares this object with the specified object for order.

Enum values

AUTO

Added in API level 30

public static final NumberFormatter.GroupingStrategy AUTO

Display grouping using the default strategy for all locales. This is the default behavior.

Note that locales may restrict grouping separators to be displayed only on 1 million or greater (for example, ee and hu) or disable grouping altogether (for example, bg currency).

Locale data is used to determine whether to separate larger numbers into groups of 2 (customary in South Asia) or groups of 3 (customary in Europe and the Americas).

See also:

NumberFormatter

MIN2

Added in API level 30

public static final NumberFormatter.GroupingStrategy MIN2

Display grouping using locale defaults, except do not show grouping on values smaller than 10000 (such that there is a minimum of two digits before the first separator).

Note that locales may restrict grouping separators to be displayed only on 1 million or greater (for example, ee and hu) or disable grouping altogether (for example, bg currency).

Locale data is used to determine whether to separate larger numbers into groups of 2 (customary in South Asia) or groups of 3 (customary in Europe and the Americas).

See also:

NumberFormatter

OFF

Added in API level 30

public static final NumberFormatter.GroupingStrategy OFF

Do not display grouping separators in any locale.

See also:

NumberFormatter

ON_ALIGNED

Added in API level 30

public static final NumberFormatter.GroupingStrategy ON_ALIGNED

Always display the grouping separator on values of at least 1000.

This option ignores the locale data that restricts or disables grouping, described in MIN2 and AUTO. This option may be useful to normalize the alignment of numbers, such as in a spreadsheet.

Locale data is used to determine whether to separate larger numbers into groups of 2 (customary in South Asia) or groups of 3 (customary in Europe and the Americas).

See also:

NumberFormatter

THOUSANDS

Added in API level 30

public static final NumberFormatter.GroupingStrategy THOUSANDS

Use the Western defaults: groups of 3 and enabled for all numbers 1000 or greater. Do not use locale data for determining the grouping strategy.

See also:

NumberFormatter

Public methods

valueOf

public static NumberFormatter.GroupingStrategy valueOf (String name)

Parameters
`name`	`String`

Returns
`NumberFormatter.GroupingStrategy`

values

public static final GroupingStrategy[] values ()

Returns
`GroupingStrategy[]`