Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / Java

Comparable — naturalny porządek obiektów

java.lang.Comparable<T> definiuje naturalny porządek obiektów przez compareTo(T o). Wynik określa kolejność, a nie odległość między wartościami.

Wersja: Java SE 21; repository runtime, production runtime not attested

Składnia

public interface Comparable<T> {
    int compareTo(T o);
}

java.lang.Comparable<T> definiuje naturalny porządek całkowity. Comparable.compareTo, czyli int compareTo(T o), zwraca wartość ujemną, zero lub dodatnią, gdy bieżący obiekt jest odpowiednio mniejszy, równoważny w porządku lub większy. Liczy się znak, nie dokładnie -1 albo 1.

Kontrakt wymaga przeciwnych znaków po zamianie argumentów, przechodniości oraz identycznych znaków porównań z każdym trzecim obiektem dla obiektów porównujących się jako zero. Wyjątek w jednym kierunku wymaga wyjątku także w przeciwnym.

Zdecydowanie zaleca się zgodność compareTo == 0 z equals; odstępstwa należy dokumentować. Bez niej zbiór uporządkowany może odrzucić nierówny obiekt jako duplikat. compareTo(null) zgłasza NullPointerException; niezgodny typ może spowodować ClassCastException.

Przykład sortuje Score przez Arrays.sort. Integer.compare zamiast odejmowania zapobiega przepełnieniu; jedyne pole rekordu zapewnia zgodność porządku z equals.

Przykłady

import java.util.Arrays;

public class Main {
    record Score(int points) implements Comparable<Score> {
        @Override
        public int compareTo(Score other) {
            return Integer.compare(points, other.points);
        }
    }

    public static void main(String[] args) {
        Score[] scores = {new Score(30), new Score(10), new Score(20)};
        Arrays.sort(scores);
        for (Score score : scores) {
            System.out.println(score.points());
        }
    }
}

Wynik

10
20
30

Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.

Źródła