Java : CompactNumberFormat - API使用例

CompactNumberFormat (Java SE 18 & JDK 18) の使用例まとめです。
だいたいのメソッドを網羅済みです。
API仕様のおともにどうぞ。

概要

CompactNumberFormatは、コンパクト形式で小数を書式設定するNumberFormatの具体的なサブクラスです。コンパクト数値書式設定は、スペースが限られている環境では設計され、その限られたスペースに書式設定された文字列を表示できます。

クラス構成

CompactNumberFormat を使うと、大きな数値を短縮した表現へと変換(フォーマット)できます。
例えば、日本のロケールでは、100000 は 10万 となります。

CompactNumberFormat のインスタンス生成には、NumberFormat の getCompactNumberInstance メソッドを使います。

System.out.println(Locale.getDefault().toLanguageTag()); // ja-JP

final var number = 10000000;

final var format1 = NumberFormat.getCompactNumberInstance();
System.out.println(format1.getClass().getSimpleName()); // CompactNumberFormat
System.out.println(format1.format(number)); // 1000万

final var format2 = NumberFormat.getCompactNumberInstance(Locale.US, NumberFormat.Style.SHORT);
System.out.println(format2.format(number)); // 10M

final var format3 = NumberFormat.getCompactNumberInstance(Locale.US, NumberFormat.Style.LONG);
System.out.println(format3.format(number)); // 10 million

final var format = NumberFormat.getCompactNumberInstance();

IntStream.range(0, 15).forEach(i -> {
    final var number = BigInteger.valueOf(10).pow(i);
    System.out.println(number + " : " + format.format(number));
});

// 結果
// ↓
//1 : 1
//10 : 10
//100 : 100
//1000 : 1,000
//10000 : 1万
//100000 : 10万
//1000000 : 100万
//10000000 : 1000万
//100000000 : 1億
//1000000000 : 10億
//10000000000 : 100億
//100000000000 : 1000億
//1000000000000 : 1兆
//10000000000000 : 10兆
//100000000000000 : 100兆

final var format = NumberFormat.getCompactNumberInstance(Locale.US, NumberFormat.Style.SHORT);

IntStream.range(0, 15).forEach(i -> {
    final var number = BigInteger.valueOf(10).pow(i);
    System.out.println(number + " : " + format.format(number));
});

// 結果
// ↓
//1 : 1
//10 : 10
//100 : 100
//1000 : 1K
//10000 : 10K
//100000 : 100K
//1000000 : 1M
//10000000 : 10M
//100000000 : 100M
//1000000000 : 1B
//10000000000 : 10B
//100000000000 : 100B
//1000000000000 : 1T
//10000000000000 : 10T
//100000000000000 : 100T

NumberFormatで宣言されたフィールド

FRACTION_FIELD, INTEGER_FIELD

「Java API 使用例 : NumberFormat」をご参照ください。

コンストラクタ

CompactNumberFormat (String decimalPattern, DecimalFormatSymbols symbols, String[] compactPatterns)

指定された小数点パターン、小数点フォーマット記号およびコンパクト・パターンを使用してCompactNumberFormatを作成します。

final String[] compactPatterns = {"", "", "", "0A", "00B", "000C"};
final var symbols = DecimalFormatSymbols.getInstance();

final var format = new CompactNumberFormat("000", symbols, compactPatterns);

System.out.println(format.format(1)); // 001
System.out.println(format.format(12)); // 012
System.out.println(format.format(123)); // 123
System.out.println(format.format(1234)); // 1A
System.out.println(format.format(12345)); // 12B
System.out.println(format.format(123456)); // 123C

CompactNumberFormat (String decimalPattern, DecimalFormatSymbols symbols, String[] compactPatterns, String pluralRules)

指定された小数点パターン、小数点フォーマット記号、圧縮パターンおよび複数形ルールを使用してCompactNumberFormatを作成します。

final String[] compactPatterns = {"{one:0x other:0y}", "{one:0xx other:0yy}"};
final var symbols = DecimalFormatSymbols.getInstance();

final var pluralRules = "one:i = 1 and v = 0";

final var format = new CompactNumberFormat("", symbols, compactPatterns, pluralRules);

System.out.println(format.format(1)); // 1x
System.out.println(format.format(2)); // 2y
System.out.println(format.format(10)); // 1xx
System.out.println(format.format(20)); // 2yy

メソッド

CompactNumberFormat clone ()

このCompactNumberFormatインスタンスのコピーを作成して返します。

final var symbols = DecimalFormatSymbols.getInstance();

final var format = new CompactNumberFormat("", symbols, new String[]{"0A", "00B", "000C"});
System.out.println(format.format(123)); // 123C

final var cloned = format.clone();

System.out.println(cloned.format(123)); // 123C
System.out.println(cloned.equals(format)); // true

boolean equals (Object obj)

このCompactNumberFormatが指定されたobjと等しいかどうかをチェックします。

final var symbols = DecimalFormatSymbols.getInstance();

final var format1 = new CompactNumberFormat("", symbols, new String[]{"0A"});
final var format2 = new CompactNumberFormat("", symbols, new String[]{"0A"});
final var format3 = new CompactNumberFormat("", symbols, new String[]{"0B"});

System.out.println(format1.equals(format2)); // true
System.out.println(format1.equals(format3)); // false
System.out.println(format2.equals(format3)); // false

StringBuffer format (double number, StringBuffer result, FieldPosition fieldPosition)

doubleをフォーマットして、コンパクトな形式を表す文字列を生成します。

if (NumberFormat.getCompactNumberInstance(Locale.US, NumberFormat.Style.SHORT)
        instanceof CompactNumberFormat format) {

    format.setMinimumFractionDigits(2);

    final var number = 12340.0;
    System.out.println(format.format(number)); // 12.34K

    {
        final var sb = new StringBuffer("num = ");
        System.out.println(sb); // num =

        final var pos = new FieldPosition(NumberFormat.INTEGER_FIELD);
        final var ret = format.format(number, sb, pos);
        System.out.println(ret); // num = 12.34K

        System.out.println(pos.getBeginIndex()); // 6
        System.out.println(pos.getEndIndex()); // 8
    }
    {
        final var sb = new StringBuffer("num = ");
        System.out.println(sb); // num =

        final var pos = new FieldPosition(NumberFormat.FRACTION_FIELD);
        final var ret = format.format(number, sb, pos);
        System.out.println(ret); // num = 12.34K

        System.out.println(pos.getBeginIndex()); // 9
        System.out.println(pos.getEndIndex()); // 11
    }
}

StringBuffer format (long number, StringBuffer result, FieldPosition fieldPosition)

longをフォーマットして、そのコンパクトな形式を表す文字列を生成します。

if (NumberFormat.getCompactNumberInstance(Locale.US, NumberFormat.Style.SHORT)
        instanceof CompactNumberFormat format) {

    format.setMinimumFractionDigits(2);

    final var number = 12340L;
    System.out.println(format.format(number)); // 12.34K

    {
        final var sb = new StringBuffer("num = ");
        System.out.println(sb); // num =

        final var pos = new FieldPosition(NumberFormat.INTEGER_FIELD);
        final var ret = format.format(number, sb, pos);
        System.out.println(ret); // num = 12.34K

        System.out.println(pos.getBeginIndex()); // 6
        System.out.println(pos.getEndIndex()); // 8
    }
    {
        final var sb = new StringBuffer("num = ");
        System.out.println(sb); // num =

        final var pos = new FieldPosition(NumberFormat.FRACTION_FIELD);
        final var ret = format.format(number, sb, pos);
        System.out.println(ret); // num = 12.34K

        System.out.println(pos.getBeginIndex()); // 9
        System.out.println(pos.getEndIndex()); // 11
    }
}

final StringBuffer format (Object number, StringBuffer toAppendTo, FieldPosition fieldPosition)

数値を書式設定して、コンパクト形式を表す文字列を生成します。

if (NumberFormat.getCompactNumberInstance(Locale.US, NumberFormat.Style.SHORT)
        instanceof CompactNumberFormat format) {

    format.setMinimumFractionDigits(2);

    final var number = new BigInteger("12340000000000");
    System.out.println(format.format(number)); // 12.34T

    {
        final var sb = new StringBuffer("num = ");
        System.out.println(sb); // num =

        final var pos = new FieldPosition(NumberFormat.INTEGER_FIELD);
        final var ret = format.format(number, sb, pos);
        System.out.println(ret); // num = 12.34T

        System.out.println(pos.getBeginIndex()); // 6
        System.out.println(pos.getEndIndex()); // 8
    }
    {
        final var sb = new StringBuffer("num = ");
        System.out.println(sb); // num =

        final var pos = new FieldPosition(NumberFormat.FRACTION_FIELD);
        final var ret = format.format(number, sb, pos);
        System.out.println(ret); // num = 12.34T

        System.out.println(pos.getBeginIndex()); // 9
        System.out.println(pos.getEndIndex()); // 11
    }
}

AttributedCharacterIterator formatToCharacterIterator (Object obj)

Objectをフォーマットし、AttributedCharacterIteratorを生成します。

if (NumberFormat.getCompactNumberInstance(Locale.US, NumberFormat.Style.SHORT)
        instanceof CompactNumberFormat format) {

    final var num = 123000;
    System.out.println(format.format(num)); // 123K

    final var it = format.formatToCharacterIterator(num);

    System.out.println("-- iterator --");
    for (char c = it.first(); c != CharacterIterator.DONE; c = it.next()) {
        System.out.println(c);
    }

    // 結果
    // ↓
    //-- iterator --
    //1
    //2
    //3
    //K
}

int getGroupingSize ()

グループ化サイズを返します。

if (NumberFormat.getCompactNumberInstance(Locale.US, NumberFormat.Style.LONG)
        instanceof CompactNumberFormat format) {

    format.setGroupingUsed(true);

    final var num = 12345000000000000L;

    System.out.println(format.getGroupingSize()); // 0
    System.out.println(format.format(num)); // 12345 trillion

    format.setGroupingSize(3);

    System.out.println(format.getGroupingSize()); // 3
    System.out.println(format.format(num)); // 12,345 trillion
}

RoundingMode getRoundingMode ()

このCompactNumberFormatで使用されているRoundingModeを取得します。

if (NumberFormat.getCompactNumberInstance(Locale.US, NumberFormat.Style.SHORT)
        instanceof CompactNumberFormat format) {

    System.out.println(format.getRoundingMode()); // HALF_EVEN

    System.out.println(format.format(1400)); // 1K
    System.out.println(format.format(1500)); // 2K
    System.out.println(format.format(1600)); // 2K

    format.setRoundingMode(RoundingMode.DOWN);
    System.out.println(format.getRoundingMode()); // DOWN

    System.out.println(format.format(1400)); // 1K
    System.out.println(format.format(1500)); // 1K
    System.out.println(format.format(1600)); // 1K
}

int hashCode ()

このCompactNumberFormatインスタンスのハッシュ・コードを返します。

if (NumberFormat.getCompactNumberInstance(Locale.US, NumberFormat.Style.SHORT)
        instanceof CompactNumberFormat format) {
    System.out.println(format.hashCode()); // 580727548
}

if (NumberFormat.getCompactNumberInstance(Locale.JAPAN, NumberFormat.Style.SHORT)
        instanceof CompactNumberFormat format) {
    System.out.println(format.hashCode()); // -2133385055
}

boolean isGroupingUsed ()

このフォーマットでグループ化が使用される場合に、trueを返します。

if (NumberFormat.getCompactNumberInstance(Locale.US, NumberFormat.Style.LONG)
        instanceof CompactNumberFormat format) {

    final var num = 12345000000000000L;
    format.setGroupingSize(3);

    System.out.println(format.isGroupingUsed()); // false
    System.out.println(format.format(num)); // 12345 trillion

    format.setGroupingUsed(true);

    System.out.println(format.isGroupingUsed()); // true
    System.out.println(format.format(num)); // 12,345 trillion
}

boolean isParseBigDecimal ()

parse(String, ParsePosition)メソッドがBigDecimalを返すかどうかを返します。

if (NumberFormat.getCompactNumberInstance(Locale.US, NumberFormat.Style.SHORT)
        instanceof CompactNumberFormat format) {

    final var text = "12345678900000000000";

    System.out.println(format.isParseBigDecimal()); // false

    final var num1 = format.parse(text);
    System.out.println(num1); // 1.23456789E19
    System.out.println(num1.getClass().getSimpleName()); // Double

    format.setParseBigDecimal(true);
    System.out.println(format.isParseBigDecimal()); // true

    final var num2 = format.parse(text);
    System.out.println(num2); // 12345678900000000000
    System.out.println(num2.getClass().getSimpleName()); // BigDecimal
}

boolean isParseIntegerOnly ()

この書式がコンパクト数値の数値コンポーネントから整数のみを解析する場合、trueを返します。

if (NumberFormat.getCompactNumberInstance(Locale.US, NumberFormat.Style.LONG)
        instanceof CompactNumberFormat format) {

    final var text = "1234.56 thousand";

    System.out.println(format.isParseIntegerOnly()); // false

    final var num1 = format.parse(text);
    System.out.println(num1); // 1234560
    System.out.println(num1.getClass().getSimpleName()); // Long

    format.setParseIntegerOnly(true);
    System.out.println(format.isParseIntegerOnly()); // true

    final var num2 = format.parse(text);
    System.out.println(num2); // 1234000
    System.out.println(num2.getClass().getSimpleName()); // Long
}

Number parse (String text, ParsePosition pos)

文字列からコンパクト形式をパースしてNumberを生成します。

if (NumberFormat.getCompactNumberInstance(Locale.US, NumberFormat.Style.SHORT)
        instanceof CompactNumberFormat format) {

    final var text = "123K 456M";
    final var pos = new ParsePosition(0);

    final var ret1 = format.parse(text, pos);
    System.out.println(ret1); // 123000
    System.out.println(pos.getIndex()); // 4

    pos.setIndex(pos.getIndex() + 1);

    final var ret2 = format.parse(text, pos);
    System.out.println(ret2); // 456000000
    System.out.println(pos.getIndex()); // 9

    final var ret3 = format.parse(text, pos);
    System.out.println(ret3); // null
}

void setGroupingSize (int newValue)

グループ化サイズを設定します。

このメソッドの使用例は、getGroupingSize() にまとめて記載しました。
そちらのAPI使用例をご参照ください。

void setGroupingUsed (boolean newValue)

グループ化をこの形式で使用するかどうかを設定します。

このメソッドの使用例は、isGroupingUsed() にまとめて記載しました。
そちらのAPI使用例をご参照ください。

void setMaximumFractionDigits (int newValue)

数値の小数部分の最大桁数を設定します。

if (NumberFormat.getCompactNumberInstance(Locale.US, NumberFormat.Style.SHORT)
        instanceof CompactNumberFormat format) {

    System.out.println(format.getMinimumFractionDigits()); // 0
    System.out.println(format.getMaximumFractionDigits()); // 0

    System.out.println(format.format(123000)); // 123K
    System.out.println(format.format(123450)); // 123K

    format.setMaximumFractionDigits(2);
    System.out.println(format.getMinimumFractionDigits()); // 0
    System.out.println(format.getMaximumFractionDigits()); // 2

    System.out.println(format.format(123000)); // 123K
    System.out.println(format.format(123450)); // 123.45K

    format.setMinimumFractionDigits(1);
    System.out.println(format.getMinimumFractionDigits()); // 1
    System.out.println(format.getMaximumFractionDigits()); // 2

    System.out.println(format.format(123000)); // 123.0K
    System.out.println(format.format(123450)); // 123.45K
}

void setMaximumIntegerDigits (int newValue)

数値の整数部分の最大桁数を設定します。

if (NumberFormat.getCompactNumberInstance(Locale.US, NumberFormat.Style.SHORT)
        instanceof CompactNumberFormat format) {

    System.out.println(format.getMinimumIntegerDigits()); // 1
    System.out.println(format.getMaximumIntegerDigits()); // 309

    System.out.println(format.format(1234500000000000000L)); // 1234500T
    System.out.println(format.format(1000)); // 1K

    format.setMinimumIntegerDigits(3);
    format.setMaximumIntegerDigits(5);

    System.out.println(format.getMinimumIntegerDigits()); // 3
    System.out.println(format.getMaximumIntegerDigits()); // 5

    System.out.println(format.format(1234500000000000000L)); // 34500T
    System.out.println(format.format(1000)); // 001K
}

void setMinimumFractionDigits (int newValue)

数値の小数部分の最小桁数を設定します。

このメソッドの使用例は、setMaximumFractionDigits(int newValue) にまとめて記載しました。
そちらのAPI使用例をご参照ください。

void setMinimumIntegerDigits (int newValue)

数値の整数部分の最小桁数を設定します。

このメソッドの使用例は、setMaximumIntegerDigits(int newValue) にまとめて記載しました。
そちらのAPI使用例をご参照ください。

void setParseBigDecimal (boolean newValue)

parse(String, ParsePosition)メソッドがBigDecimalを返すかどうかを設定します。

このメソッドの使用例は、isParseBigDecimal() にまとめて記載しました。
そちらのAPI使用例をご参照ください。

void setParseIntegerOnly (boolean value)

この書式設定でコンパクト数値のコンポーネントから整数のみを解析するかどうかを設定します。

このメソッドの使用例は、isParseIntegerOnly() にまとめて記載しました。
そちらのAPI使用例をご参照ください。

void setRoundingMode (RoundingMode roundingMode)

このCompactNumberFormatで使用するRoundingModeを設定します。

このメソッドの使用例は、getRoundingMode() にまとめて記載しました。
そちらのAPI使用例をご参照ください。

NumberFormatで宣言されたメソッド

format, format, getAvailableLocales, getCompactNumberInstance, getCompactNumberInstance, getCurrency, getCurrencyInstance, getCurrencyInstance, getInstance, getInstance, getIntegerInstance, getIntegerInstance, getMaximumFractionDigits, getMaximumIntegerDigits, getMinimumFractionDigits, getMinimumIntegerDigits, getNumberInstance, getNumberInstance, getPercentInstance, getPercentInstance, parse, parseObject, setCurrency