com.ibm.icu.number

Enum NumberFormatter.GroupingStrategy

java.lang.Object

java.lang.Enum<NumberFormatter.GroupingStrategy>

com.ibm.icu.number.NumberFormatter.GroupingStrategy

All Implemented Interfaces:

Serializable, Comparable<NumberFormatter.GroupingStrategy>

Enclosing class:

NumberFormatter

public static enum NumberFormatter.GroupingStrategy
extends Enum<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

Status:

Stable ICU 61.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO Display grouping using the default strategy for all locales.
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).
OFF Do not display grouping separators in any locale.
ON_ALIGNED Always display the grouping separator on values of at least 1000.
THOUSANDS Use the Western defaults: groups of 3 and enabled for all numbers 1000 or greater.

Method Summary

Modifier and Type	Method and Description
static NumberFormatter.GroupingStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static NumberFormatter.GroupingStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OFF

public static final NumberFormatter.GroupingStrategy OFF

Do not display grouping separators in any locale.

See Also:

NumberFormatter

Status:

Stable ICU 61.

MIN2

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

Status:

Stable ICU 61.

AUTO

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

Status:

Stable ICU 61.

ON_ALIGNED

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

Status:

Stable ICU 61.

THOUSANDS

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

Status:

Stable ICU 61.

Method Detail

values

public static NumberFormatter.GroupingStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NumberFormatter.GroupingStrategy c : NumberFormatter.GroupingStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NumberFormatter.GroupingStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null