Класс CompactNumberFormat

public final class CompactNumberFormat extends NumberFormat

Класс CompactNumberFormat — это конкретный подкласс NumberFormat, который форматирует десятичное число в компактной форме. Компактное форматирование чисел предназначено для сред, где ограничено пространство, и отформатированная строка может быть отображена в этом ограниченном пространстве. Оно определено спецификацией LDML для компактных форматов чисел. Компактное форматирование чисел относится к представлению числа в более короткой форме, на основе шаблонов, предоставленных для данного регионального варианта.

Например:
В регионе US locale, 1000 может быть отформатировано как "1K", а 1000000 как "1M", в зависимости от используемого стиля.
В регионе "hi_IN" 1000 может быть отформатировано как "1 हज़ार", а 50000000 как "5 क.", в зависимости от используемого стиля.

Чтобы получить CompactNumberFormat для регионального варианта, используйте один из методов фабрики, предоставляемых NumberFormat для компактного форматирования чисел. Например, NumberFormat.getCompactNumberInstance(Locale, Style).

NumberFormat fmt = NumberFormat.getCompactNumberInstance(
                            Locale.forLanguageTag("hi-IN"), NumberFormat.Style.SHORT);
String result = fmt.format(1000);

Стиль

Число можно отформатировать в компактной форме с двумя различными стилями, SHORT и LONG. Используйте NumberFormat.getCompactNumberInstance(Locale, Style) для форматирования и разбора числа в SHORT или LONG компактной форме, где заданный параметр Style указывает требуемый формат. SHORT стиль компактного представления чисел в регионе US locale форматирует 10000 как "10K". Однако, LONG стиль в том же регионе форматирует 10000 как "10 thousand".

Шаблоны компактных чисел

Шаблоны компактных чисел представлены рядом шаблонов, где каждый шаблон используется для форматирования диапазона чисел. Пример SHORT стилизованных шаблонов компактных чисел для региона US locale — это {"", "", "", "0K", "00K", "000K", "0M", "00M", "000M", "0B", "00B", "000B", "0T", "00T", "000T"}, варьирующийся от 100 до 1014. Может быть любое количество шаблонов, и они строго основаны на индексах, начиная с диапазона 100. Например, в приведенных выше шаблонах шаблон с индексом 3 ("0K") используется для форматирования number >= 1000 and number < 10000, шаблон с индексом 4 ("00K") используется для форматирования number >= 10000 and number < 100000 и так далее. В большинстве региональных вариантов шаблоны с диапазоном 100—102 являются пустыми строками, что подразумевает специальный шаблон "0". Специальный шаблон "0" используется для любого диапазона, который не содержит компактный шаблон. Этот специальный шаблон может быть указан явно для любого определенного диапазона или рассматриваться как шаблон по умолчанию для пустой строки.

Компактный шаблон содержит положительный и отрицательный подшаблон, разделенные символом границы подшаблона ';' (U+003B), например, "0K;-0K". Каждый подшаблон имеет префикс, минимальное количество целых цифр и суффикс. Отрицательный подшаблон является необязательным; если его нет, то положительный подшаблон с префиксом минус ('-' U+002D HYPHEN-MINUS) используется в качестве отрицательного подшаблона. То есть, "0K" эквивалентно "0K;-0K". Если есть явный отрицательный подшаблон, он служит только для указания отрицательного префикса и суффикса. Количество минимальных целых цифр и другие характеристики одинаковы для положительного шаблона. Это означает, что "0K;-00K" создает точно такой же результат, как "0K;-0K".

Многие символы в компактном шаблоне интерпретируются буквально; они сопоставляются во время разбора и выводятся без изменений при форматировании. Специальные символы, с другой стороны, представляют другие символы, строки или классы символов. Они должны быть заключены в одинарные кавычки ' (U+0027), если они должны появиться в префиксе или суффиксе как литералы. Например, 0क'.'.

Множественное число

В случае, если для локализации требуется, чтобы шаблоны компактных чисел были разными для множественного числа, каждый единичный и множественный шаблон может быть перечислен в паре фигурных скобок '{' (U+007B) и '}' (U+007D), разделенных пробелом ' ' (U+0020). Если используется этот формат, каждый шаблон должен быть дополнен своим count, за которым следует двоеточие ':' (U+003A). Если шаблон включает пробелы буквально, они должны быть заключены в кавычки.

Например, шаблон компактного числа, представляющий миллионы в немецкой локали, может быть указан как "{one:0' 'Million other:0' 'Millionen}". count следует правилам множественного числа LDML Language Plural Rules.

Компактный шаблон имеет следующий синтаксис:

 Pattern:
         SimplePattern
         '{' PluralPattern [' ' PluralPattern]optional '}'
 SimplePattern:
         PositivePattern
         PositivePattern [; NegativePattern]optional
 PluralPattern:
         Count:SimplePattern
 Count:
         "zero" / "one" / "two" / "few" / "many" / "other"
 PositivePattern:
         Prefixoptional MinimumInteger Suffixoptional
 NegativePattern:
        Prefixoptional MinimumInteger Suffixoptional
 Prefix:
      Any Unicode characters except U+FFFE, U+FFFF, and
      special characters.
 Suffix:
      Any Unicode characters except U+FFFE, U+FFFF, and
      special characters.
 MinimumInteger:
      0
      0 MinimumInteger
 

Форматирование

По умолчанию поведение форматирования возвращает отформатированную строку без дробной части, однако пользователи могут использовать метод setMinimumFractionDigits(int) для включения дробной части. Число 1000.0 или 1000 форматируется как "1K", а не как "1.00K" (в регионе US locale). По этой причине предоставленные шаблоны для форматирования содержат только минимальное количество целых цифр, префикс и/или суффикс, но не дробную часть. Например, используемые шаблоны — {"", "", "", 0K, 00K, ...}. Если шаблон, выбранный для форматирования числа, является "0" (специальный шаблон), явным или по умолчанию, то используется общее форматирование чисел, предоставляемое DecimalFormat для указанного регионального варианта.

Разбор

По умолчанию поведение разбора не допускает разделитель группировки, пока разделитель группировки не будет установлен в true с помощью setGroupingUsed(boolean). Разбор дробной части зависит от isParseIntegerOnly(). Например, если разбор целой части только установлен в true, то дробная часть пропускается.

Округление

CompactNumberFormat предоставляет режимы округления, определённые в RoundingMode для форматирования. По умолчанию используется RoundingMode.HALF_EVEN.