Java : Comparable (比較) - API使用例

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

概要

このインタフェースを実装する各クラスのオブジェクトに全体順序付けを強制します。この順序付けはクラスの「自然順序付け」と呼ばれ、クラスのcompareToメソッドは「自然比較メソッド」と呼ばれます。

クラス構成

Comparable インタフェースを実装したクラスは、オブジェクトの大小の比較が可能となります。
主に、Collections.sort や Arrays.sort、Stream.sorted などのソートに使われます。

似た API に、Comparator インタフェースがあります。
Comparable は実装したクラス自体が比較可能になるのに対して、Comparator は比較対象となるクラスに手を加える必要はありません。

// String クラスは Comparable を実装しています。
final Comparable<String> comparable = "bbb";

System.out.println(comparable.compareTo("aaa")); // 1
System.out.println(comparable.compareTo("bbb")); // 0
System.out.println(comparable.compareTo("ccc")); // -1

final var list = List.of("ddd", "bbb", "ccc", "aaa");
System.out.println(list); // [ddd, bbb, ccc, aaa]

final var sorted = list.stream().sorted().toList();
System.out.println(sorted); // [aaa, bbb, ccc, ddd]

メソッド

int compareTo (T o)

このオブジェクトと指定されたオブジェクトの順序を比較します。

// String クラスは Comparable を実装しています。
final var list = List.of("ddd", "bbb", "ccc", "aaa");
System.out.println(list); // [ddd, bbb, ccc, aaa]

final var sorted = list.stream().sorted().toList();
System.out.println(sorted); // [aaa, bbb, ccc, ddd]

record Sample(String text, int num) implements Comparable<Sample> {
    @Override
    public String toString() {
        return "(%s, %d)".formatted(text, num);
    }

    @Override
    public int compareTo(Sample o) {
        if (!text.equals(o.text())) {
            return text.compareTo(o.text());
        } else {
            return num - o.num();
        }
    }
}

final var list = List.of(
        new Sample("bbb", 2), new Sample("bbb", 3), new Sample("bbb", 1),
        new Sample("aaa", 3), new Sample("aaa", 1), new Sample("aaa", 2)
);

// [(bbb, 2), (bbb, 3), (bbb, 1), (aaa, 3), (aaa, 1), (aaa, 2)]
System.out.println(list);

final var sorted = list.stream().sorted().toList();

// [(aaa, 1), (aaa, 2), (aaa, 3), (bbb, 1), (bbb, 2), (bbb, 3)]
System.out.println(sorted);

API 使用例

Java : Comparable (比較) - API使用例

概要

メソッド

int compareTo (T o)

関連記事