Added in API level 30

GroupingStrategy


class GroupingStrategy
kotlin.Any
   ↳ kotlin.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.

Summary

Enum values

Display grouping using the default strategy for all locales.

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).

Do not display grouping separators in any locale.

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

Use the Western defaults: groups of 3 and enabled for all numbers 1000 or greater.

Enum values

AUTO

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

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).

MIN2

Added in API level 30
enum val MIN2 : NumberFormatter.GroupingStrategy

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).

OFF

Added in API level 30
enum val OFF : NumberFormatter.GroupingStrategy

Do not display grouping separators in any locale.

ON_ALIGNED

Added in API level 30
enum val ON_ALIGNED : NumberFormatter.GroupingStrategy

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).

THOUSANDS

Added in API level 30
enum val THOUSANDS : NumberFormatter.GroupingStrategy

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.