Javaのソートについて

Question

このサンプルコードの
[12]のreturn this.number() - car.number();
がどういう処理をしているのかがわからないです。
何故、何を引き算しているんでしょう？

import java.util.ArrayList;
import java.util.Collections;
 
public class CollectionsSortWithoutComparator {
    public static void main(String[] args) {
        ArrayList <CarImplementedComparable>list = new ArrayList<CarImplementedComparable>();//[1]
        list.add(new CarImplementedComparable(105, "red"));//[2]
        list.add(new CarImplementedComparable(102, "blue"));//[3]
        list.add(new CarImplementedComparable(101, "green"));//[4]
        list.add(new CarImplementedComparable(104, "yellow"));//[5]
        list.add(new CarImplementedComparable(103, "black"));//[6]
 
        Collections.sort(list);//[7]
        for (CarImplementedComparable carNumber: list) {//[8]
            System.out.print("[9] Car Number = " + carNumber.number());//[9]
            System.out.println(", Cokor = " + carNumber.color());
        }
    }
}

public class CarImplementedComparable implements Comparable<CarImplementedComparable> {//[20]
    private int number;//[21]
    private String color;//[22]
    public CarImplementedComparable(int number, String color) {//[23]
        this.number = number;//[24]
        this.color = color;//[25]
    }
    public int number() {//[26]
        return this.number;//[27]
    }
    public String color() {//[28]
        return this.color;//[29]
    }
    @Override
    public int compareTo( CarImplementedComparable car ){//[11]
        return this.number() - car.number();//[12]
    }
} 

Answer 1

既に回答がついているとおり、『そのように実装する決まりだから』です。
とは言え随分分かりづらいですから、私なら次のように書きます。

@Override
public int compareTo(CarImplementedComparable car) {
    return Integer.compare(this.number, car.number);
}

あるいはコンパレータを使います。(そもそも『比較できる車』って何なんだ)
ついでにtoStringをオーバーライドすると、次のように書けます。

import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;


class Main {
    public static void main(String[] args) {
        List<Car> list = new ArrayList<>();
        list.add(new Car(105, "red"));
        list.add(new Car(102, "blue"));
        list.add(new Car(101, "green"));
        list.add(new Car(104, "yellow"));
        list.add(new Car(103, "black"));

        list.sort(Comparator.comparing(Car::getNumber));
        for(Car car: list) {
            System.out.println(car);
        }
    }
}

class Car {
    private int number;
    private String color;
    
    public Car(int number, String color) {
        this.number = number;
        this.color = color;
    }
    public int getNumber() {
        return this.number;
    }
    public String getColor() {
        return this.color;
    }
    
    @Override
    public String toString() {
        return String.format(
            "Car Number = %d, color = %s.", number, color
        );
    }
} 

もっと改造して良いならmainメソッドはこう書きます。だいぶスッキリします。

class Main {
    public static void main(String[] args) {
        var list = List.of(
            new Car(105, "red"), new Car(102, "blue"), new Car(101, "green"),
            new Car(104, "yellow"), new Car(103, "black")
        );

        list.stream()
            .sorted(Comparator.comparing(Car::getNumber))
            .forEach(System.out::println)
        ;
    }
}

varに依る型省略はJava10以降の、List.ofはJava9以降の、Stream処理はJava8以降の機能です。

Answer 2

まんまリファレンスの言葉ですが、

このオブジェクトが指定されたオブジェクトより小さい場合は負の整数、等しい場合はゼロ、大きい場合は正の整数を返します。

ということだからです。
https://docs.oracle.com/javase/jp/8/docs/api/java/lang/Comparable.html#compareTo-T-

Comments

[swordone]

[]と()の中身逆じゃないかい

[dice142]

ご指摘ありがとうございます。
投稿中に( )内を間違えていたので修正したはずなのですが、teratailのバグなのか反映されてなかったです。。。