CKTIS / Java
Comparable.compareTo(): porządek naturalny w Javie
Porównuj obiekty według ich porządku naturalnego. Sprawdzaj znak wyniku, odróżniaj remis od równości według equals i świadomie wybieraj wynik przy remisie.
Wersja: Java SE 21
Składnia
Java SE 21 — java.lang.Comparable<T>
Interface method: int compareTo(T other);
Call: int result = a.compareTo(b);
Implementation signature for MyType implements Comparable<MyType>: @Override public int compareTo(MyType other)
Generic bound for natural-order helpers: <T extends Comparable<? super T>>Comparable.compareTo() to zapis nazwy metody instancyjnej int compareTo(T other) z interfejsu java.lang.Comparable<T>. Wywołanie a.compareTo(b) ma jeden argument i porównuje a z b w porządku naturalnym. Wynik < 0 oznacza, że a jest przed b, == 0 oznacza remis, a > 0 — że a jest za b. Nie zakładaj, że wynikiem jest dokładnie -1 lub 1. Do innego porządku użyj Comparator<T> i wywołania compare(a, b).
Zamiana argumentów porównania miejscami musi odwracać znak wyniku, porządek musi być przechodni, a obiekty remisujące muszą dawać ten sam znak w porównaniu z dowolnym trzecim porównywalnym obiektem. W hierarchii klas stosuj wspólne reguły porównywania klas bazowych i pochodnych, jeśli ich obiekty można porównywać ze sobą. Pola typu int porównuj przez Integer.compare(x, y), nie przez x - y, bo odejmowanie może się przepełnić. Argument null powoduje NullPointerException, a typ uniemożliwiający porównanie — ClassCastException.
Zgodność z equals jest zdecydowanie zalecana, ale nie jest wymagana: a.compareTo(b) == 0 i a.equals(b) powinny dawać ten sam wynik logiczny. Udokumentuj odstępstwo. Na przykład wartości BigDecimal 2.00 i 2.0 remisują w porządku naturalnym, lecz equals zwraca false, bo mają różne skale. TreeSet bez komparatora traktuje je jako ten sam element.
Ograniczenie generyczne <T extends Comparable<? super T>> pozwala porównywać wartości T, nawet gdy T dziedziczy Comparable dla nadtypu. Szukając minimum lub maksimum, aktualizuj kandydata tylko wtedy, gdy nowy element jest ściśle mniejszy (< 0) lub większy (> 0), aby zachować pierwszy element przy remisie. Dla dwóch argumentów warunek a.compareTo(b) <= 0 wybiera a przy remisie.
Przed ograniczeniem wartości do przedziału (clamp) sprawdź min.compareTo(max) <= 0. Poniżej zakresu zwróć min, powyżej max, a w pozostałych przypadkach zwróć pierwotną wartość, także gdy remisuje z którąś granicą.
Przykłady
import java.math.BigDecimal;
public class Main {
static <T extends Comparable<? super T>> T min(T a, T b) {
return a.compareTo(b) <= 0 ? a : b;
}
static <T extends Comparable<? super T>> T clamp(T value, T min, T max) {
if (min.compareTo(max) > 0) {
throw new IllegalArgumentException("min > max");
}
if (value.compareTo(min) < 0) return min;
if (value.compareTo(max) > 0) return max;
return value;
}
public static void main(String[] args) {
BigDecimal a = new BigDecimal("2.00");
BigDecimal b = new BigDecimal("2.0");
BigDecimal high = new BigDecimal("3");
System.out.println("a < high: " + (a.compareTo(high) < 0));
System.out.println("a compares equal to b: " + (a.compareTo(b) == 0));
System.out.println("a.equals(b): " + a.equals(b));
System.out.println("min: " + min(a, b));
System.out.println("clamp: " + clamp(new BigDecimal("4"), a, high));
}
}Wynik
a < high: true a compares equal to b: true a.equals(b): false min: 2.00 clamp: 3
`a` i `b` remisują liczbowo, ale różnią się skalą. `min(a, b)` zachowuje pierwszy argument, więc wypisuje `2.00`. `clamp` zwraca górną granicę `3`, ponieważ `4` ją przekracza.
Powiązane lekcje
- Java · Lekcja 5 · Zaawansowany · Wersja: 2
- Java · Lekcja 11 · Zaawansowany · Wersja: 2
- Java · Lekcja 15 · Zaawansowany · Wersja: 2
- Java · Lekcja 48 · Podstawowy · Wersja: 2
- Java · Lekcja 5 · Średniozaawansowany · Wersja: 2