CKTIS / Java
Comparable.compareTo(): natürliche Ordnung in Java
Vergleiche Objekte nach ihrer natürlichen Ordnung. Lies das Vorzeichen des Ergebnisses, unterscheide Gleichstand von equals und entscheide, welches Objekt bei Gleichstand bleibt.
Version: Java SE 21
Syntax
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() bezeichnet die Instanzmethode int compareTo(T other) der Schnittstelle java.lang.Comparable<T>. Der Aufruf a.compareTo(b) hat ein Argument und vergleicht a und b nach ihrer natürlichen Ordnung. Bei < 0 kommt a vor b, bei == 0 besteht Gleichstand und bei > 0 kommt a nach b. Verlass dich nicht darauf, dass das Ergebnis genau -1 oder 1 ist. Für eine andere Ordnung verwende einen Comparator<T> und rufe compare(a, b) auf.
Beim Vertauschen der Operanden muss sich das Vorzeichen umkehren. Die Ordnung muss transitiv sein, und bei Gleichstand müssen Vergleiche mit einem beliebigen dritten vergleichbaren Objekt dasselbe Vorzeichen ergeben. Verwende in einer Klassenhierarchie gemeinsame Ordnungsregeln für Instanzen der Basis- und Unterklassen, wenn sie untereinander vergleichbar sind. Vergleiche int-Felder mit Integer.compare(x, y) statt mit x - y, denn die Subtraktion kann überlaufen. Das Argument null führt zu einer NullPointerException; verhindert der Typ des Arguments den Vergleich, folgt eine ClassCastException.
Konsistenz mit equals wird dringend empfohlen, ist aber nicht vorgeschrieben: a.compareTo(b) == 0 und a.equals(b) sollten denselben Wahrheitswert liefern. Dokumentiere Abweichungen. Die BigDecimal-Werte 2.00 und 2.0 haben zum Beispiel in der natürlichen Ordnung Gleichstand, aber equals liefert wegen ihrer unterschiedlichen Skalen false. Ein TreeSet ohne Komparator behandelt sie als dasselbe Element.
Die generische Schranke <T extends Comparable<? super T>> erlaubt den Vergleich von Werten des Typs T, auch wenn T Comparable für einen Obertyp erbt. Ersetze bei der Suche nach dem Minimum oder Maximum die bisherige Wahl nur, wenn das neue Element strikt kleiner (< 0) beziehungsweise größer (> 0) ist. So bleibt bei Gleichstand das erste Element erhalten. Bei zwei Argumenten wählt a.compareTo(b) <= 0 im Gleichstand a.
Prüfe vor dem Begrenzen eines Werts auf ein Intervall (clamp), ob min.compareTo(max) <= 0 gilt. Gib unterhalb des Intervalls min zurück, oberhalb max, sonst den ursprünglichen Wert, auch bei Gleichstand mit einer Grenze.
Beispiele
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));
}
}Ergebnis
a < high: true a compares equal to b: true a.equals(b): false min: 2.00 clamp: 3
`a` und `b` sind numerisch gleich, haben aber unterschiedliche Skalen. `min(a, b)` behält das erste Argument bei, deshalb erscheint `2.00` in der Ausgabe. `clamp` gibt die Obergrenze `3` zurück, weil `4` darüber liegt.
Zugehörige Lektionen
- Java · Lektion 5 · Fortgeschritten · Version: 2
- Java · Lektion 11 · Fortgeschritten · Version: 2
- Java · Lektion 15 · Fortgeschritten · Version: 2
- Java · Lektion 48 · Grundlagen · Version: 2
- Java · Lektion 5 · Mittlere Stufe · Version: 2